前言¶
DeepSeek Harness (DSH) 生态强调插件化,以解决特定场景需求。在开发或使用 AI 助手时,访问库和框架的技术文档是常见需求,但直接访问官方文档往往面临格式杂乱、信息碎片化等问题,难以直接被大语言模型有效利用。
xby-atlas-docs 插件提供了一套解决方案。它作为一个 MCP 服务器,将官方文档处理为适合 LLM 使用的 Markdown 版本,供 Cursor、Cline、Windsurf 等 MCP 兼容的客户端调用。
核心功能¶
该插件提供以下核心能力:
set_xby_apikey:在聊天会话中设置 API 密钥,该密钥会自动持久化,重启 DSH 进程后依然有效。list_docs:列出所有可用的文档库和框架集合。这是使用其他文档工具的先决条件,必须先获取docName。search_docs:在特定的文档集合中搜索包含特定关键词的页面。返回匹配页面的路径和描述,通常用于快速定位。get_docs_index:获取文档集合的精简索引,以 Markdown 格式列出所有页面。用于初始探索,了解文档涵盖范围。get_docs_page:根据相对路径获取单个文档页面的完整内容。在通过get_docs_index或search_docs确定目标页面后,使用此工具获取详情。get_docs_full:获取整个文档集合的完整内容。当需要综合知识或分析完整上下文时使用,但会返回大量文本。
安装与启用¶
安装该插件需要通过 DSH 的命令行工具执行。
- 确保已安装 DeepSeek Harness。
- 执行以下命令添加插件:
dsh plugin --profile web add github:xby_skill/xby-atlas-docs
安装后,插件即可在 MCP 兼容的客户端中可用。
典型用法¶
使用该插件通常遵循“发现-探索-获取”的流程。
- 设置密钥:首先在对话中调用
set_xby_apikey,并填入从小笨羊官网获取的密钥。 - 列出文档:调用
list_docs,获取所有可用的文档集合名称(docName)。 - 探索或搜索:根据需要,调用
get_docs_index查看文档目录结构,或调用search_docs查找特定关键词。 - 获取详情:使用
get_docs_page获取具体页面的内容。
注意事项¶
- API 密钥:使用该插件需要 API 密钥,请前往小笨羊官网注册并获取。
- 前置步骤:在使用
search_docs、get_docs_index或get_docs_page之前,必须先使用list_docs获取正确的docName。 - 性能建议:
get_docs_full会返回大量文本,可能导致上下文过长或处理缓慢。建议优先使用get_docs_page或search_docs进行针对性的信息查询。
结语¶
xby-atlas-docs 将技术文档标准化,降低了 AI 助手调用特定技术文档的门槛。对于需要在代码生成、调试或技术咨询中引用特定库文档的开发者来说,这是一个实用的工具。
插件目录:https://www.skillhub.cn/plugins/xby-skill/xby-atlas-docs
GitHub 仓库:https://github.com/xby-skill/xby-atlas-docs