前言¶
在編寫技術文檔或架構圖時,開發者需要頻繁查閱 Mermaid 圖表的語法規範。手動搜索不僅耗時,還容易因版本差異導致文檔錯誤。DeepSeek Harness (DSH) 插件生態旨在解決此類集成問題,提供開箱即用的能力。下面介紹 xby-mermaid-doc 插件。
插件概覽¶
- 名稱:xby-mermaid-doc
- 維護者:xby-skill
- 分類:聯網工具
- 核心描述:Mermaid Doc MCP Server是一個用於生成Mermaid文檔的服務器,提供列出可用圖表和檢索特定圖表文檔的功能。
- 許可:MIT
核心功能¶
插件通過 MCP (Model Context Protocol) 協議提供兩個主要工具:
-
set_xby_apikey
在聊天中設置 API 密鑰。該操作會自動持久化,重啓 DSH 進程後依然有效。 -
get_diagram_doc
檢索特定 Mermaid 圖表的文檔內容。
* 參數:diagram_name(DiagramType)
* 返回值:字符串 (str)
安裝與啓用¶
推薦使用官方提供的命令進行安裝:
dsh plugin --profile web add github:xby_skill/xby-mermaid-doc
安裝完成後,插件即可在對應的 Profile (如 web) 中生效。本地開發調試時也可使用絕對路徑安裝:
dsh plugin --profile web add /absolute/path/to/xby-mermaid-doc
配置與使用¶
獲取密鑰:在使用前,需要從 小笨羊官網 註冊並獲取 API 密鑰。
調用示例:在聊天中調用 get_diagram_doc 時,需傳入具體的圖表類型名稱。支持的圖表類型包括但不限於:architecture, block, c4, classDiagram, entityRelationshipDiagram, examples, flowchart, gantt, gitgraph, kanban, mindmap, packet, pie, quadrantChart, radar, requirementDiagram, sankey, sequenceDiagram, stateDiagram, timeline, userJourney, xyChart, zenuml。
注意事項¶
- 參數大小寫敏感:
diagram_name參數區分大小寫。 - 查詢結果:未找到圖表時,返回空字符串。
- 依賴外部服務:需從小笨羊官網獲取 API 密鑰。
結語¶
該插件通過封裝 Mermaid 文檔檢索邏輯,降低了在 DSH 環境中編寫技術文檔的門檻。更多細節可查看 GitHub 倉庫 或 社區目錄。