Agent Skills
返回列表
💻

Mermaid文档生成服务

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @org-rn88lg3j/mermaid-document 到你的 AI 助手。

技能介绍

解决什么问题

写 Mermaid 图表时，最容易卡住的往往不是画图本身，而是语法细节：某类图该用哪个关键字、箭头类型怎么拼、sequenceDiagram 的分支语法怎么写。翻官方文档意味着在十几个页面里找一段话，而在对话式工作流里，手动查文档会打断节奏。这个技能把“查 Mermaid 图表文档”这一步收进工具调用：模型负责理解意图并路由，脚本负责调 API，用户只需说一句“给我看时序图的语法”。

核心能力与关键步骤

技能的核心是一个工具函数 scripts.tools.get_diagram_doc，输入 diagram_name 参数，返回对应图表的文档内容。模型侧承担路由层职责，工作流程固定为五步：

  • 检查 API 密钥：若 scripts.config.settings.api_key 为空，先通过 AskUserQuestion 向用户询问，拿到后调用 scripts.config.set_api_key(key) 保存；
  • 选择工具：根据用户意图匹配到 get_diagram_doc；
  • 提取参数：从对话中抽取目标图表名；
  • 调用工具：以关键字参数执行 scripts.tools.get_diagram_doc(diagram_name='...')；
  • 返回结果：整理 result["raw"] 中的原始数据后展示。

支持的图表类型覆盖 23 种常见写法，包括 flowchart、sequenceDiagram、gantt、pie、stateDiagram、mindmap、c4、sankey 等，参数值区分大小写。

适用边界与注意点

这个技能只做文档检索，不生成图表渲染结果，也不会校验用户写好的代码；图表文档缺失时返回空字符串。它强依赖外部 API 密钥（XBY_APIKEY），缺少密钥时必须先询问用户，禁止自行搜索或编造内容。另外，它适合在对话中快速查语法说明，如果你需要离线环境或批量处理全部图表文档，它并不覆盖这类场景。

使用场景

  • 正在编写系统设计文档，需要确认 `stateDiagram` 的状态转移语法时调用该服务。
  • 准备周报甘特图，想查 `gantt` 图的标题和日期格式规则，直接通过对话获取。
  • 复盘一个微服务调用链路，想确认 `sequenceDiagram` 中参与者的激活语法。
  • 画产品功能脑图时，需要确认 `mindmap` 根节点与子节点的正确缩进写法。

适合人员

  • 后端开发工程师，在编写接口文档或系统架构说明时需要快速查阅 Mermaid 语法。
  • 技术博客作者，在教程文章中使用 Mermaid 图前，需要核对特定图表类型的标准写法。
  • 计算机专业学生，在撰写算法作业或课程设计报告时，希望直接获取图表示例避免格式错误。
  • 数据分析师，在汇报中使用桑基图或饼图前，需要确认 Mermaid 对应的配置参数。