前言¶
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