前言¶

在编写技术文档或架构图时，开发者需要频繁查阅 Mermaid 图表的语法规范。手动搜索不仅耗时，还容易因版本差异导致文档错误。DeepSeek Harness (DSH) 插件生态旨在解决此类集成问题，提供开箱即用的能力。下面介绍 xby-mermaid-doc 插件。

插件概览¶

• 名称：xby-mermaid-doc
• 维护者：xby-skill
• 分类：联网工具
• 核心描述：Mermaid Doc MCP Server是一个用于生成Mermaid文档的服务器，提供列出可用图表和检索特定图表文档的功能。
• 许可：MIT

核心功能¶

插件通过 MCP (Model Context Protocol) 协议提供两个主要工具：

1. set_xby_apikey
   在聊天中设置 API 密钥。该操作会自动持久化，重启 DSH 进程后依然有效。

2. 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。

注意事项¶

1. 参数大小写敏感：diagram_name 参数区分大小写。
2. 查询结果：未找到图表时，返回空字符串。
3. 依赖外部服务：需从小笨羊官网获取 API 密钥。

结语¶

该插件通过封装 Mermaid 文档检索逻辑，降低了在 DSH 环境中编写技术文档的门槛。更多细节可查看 GitHub 仓库 或 社区目录。