SuperAPI AI 工具集

class-diagram

编程与开发

查看项目

更新于 10-15 18:46

技能介绍

class-diagram 用于从代码库生成 Mermaid 类图,呈现类型、关系与公共接口。

用途:理解类层次与继承;记录模块公共 API;分析组合与继承模式;回答“存在哪些类型及它们如何关联”。不适用于模块级依赖导入(应使用 cartograph:dependency-graph)或运行时数据流动(应使用 cartograph:data-flow)。

工作流程:

  1. 探索代码库:调度 Agent(cartograph:codebase-explorer),提示其探索指定范围并返回结构模型,聚焦类、dataclass、protocol、类型别名、继承与组合;提取类名、公共方法、属性、父类和组合类型。
  2. 生成 Mermaid 语法:使用 classDiagram 类型;仅展示公共方法与关键属性;关系记号包括 <|-- 继承、*-- 组合、o-- 聚合、..> 依赖/使用;为特殊类型添加构造型,如 <<protocol>>、<<dataclass>>、<<enum>>、<<abstract>>;类数量最多 12–15 个;用 namespace 分组相关类;省略私有方法与 dunder 方法;方法显示返回类型。
  3. 通过 MCP 渲染:调用 mcp__claude_ai_Mermaid_Chart__validate_and_render_mermaid_diagram,传入 prompt、mermaidCode、diagramType: "classDiagram"、clientName: "claude-code"。渲染失败可修复语法并重试,最多 2 次。
  4. 呈现结果:展示渲染图并附分析说明,包括类总数与关系数量、识别出的关键继承层次、注意到的组合模式。

退出标准:生成至少包含一个类定义(含公共方法或属性)的 Mermaid classDiagram 语法;MCP 渲染调用成功;分析说明包含类总数、继承层次与组合模式;图中不含私有方法和 dunder 方法;类数量最多 15 个,超出时应用聚合并注明。

限制:官方文本暂未提供;是否收费、可用平台及更多细节暂未提供。