核心用法
architecture-diagram 是一个代码架构可视化技能,通过多步骤工作流将复杂代码库转化为直观的 Mermaid 流程图:
1. 代码库探索:派遣专用 agent 分析指定范围(scope),提取包结构、模块及其关系
2. Mermaid 生成:将结构模型转换为符合规范的 Mermaid 语法,支持 TD(层级式)或 LR(管道式)布局
3. 图形渲染:通过 MCP 调用 Mermaid Chart 服务完成渲染,含失败重试机制
4. 结果呈现:向用户展示渲染图并附 2-3 句摘要
图表规范:限制 15-20 节点,使用 subgraph 分组、形状区分组件类型(矩形为模块、圆角矩形为入口点、圆柱为数据库、菱形为决策点)。
显著优点
- 降低认知门槛:新人 onboarding 时可快速把握系统全貌
- PR 审查辅助:架构变更一目了然
- 标准化输出:Mermaid 语法广泛兼容,可嵌入文档与版本控制
- 自动化探索:无需手动梳理,agent 智能扫描代码结构
潜在局限
- 大型代码库需限定 scope,否则节点易超限(15-20 节点上限)
- 依赖 MCP 渲染服务,离线环境受限
- 复杂动态依赖(运行时加载)可能无法静态分析
- 形状语义为约定俗成,需团队统一理解
适合人群
- 新加入开发者熟悉项目结构
- 技术负责人进行架构评审与文档维护
- 开源项目贡献者理解插件/模块关系
常规风险
- 信息泄露:分析 scope 可能暴露敏感路径或内部模块命名
- 渲染依赖:MCP 服务故障或网络中断导致流程中断
- 模型偏差:agent 探索结果可能遗漏关键依赖或误判关系