在 GitHub Codespace 中开发时,绘制架构图往往需要手动操作或借助外部工具。xby-awslabs-aws-diagram 插件通过 Amazon Q CLI 和 MCP 服务器,允许你直接在对话中编写 Python 代码,利用 diagrams 包生成高质量的架构图。
这是一个 DSH 插件,类别属于模型推理。它提供了一套工具,用于生成包括 AWS 架构图、序列图、Kubernetes 图表在内的多种可视化图表。插件由 xby-skill 维护,开源协议为 MIT。
安装¶
使用 DSH CLI 添加插件:
dsh plugin --profile web add github:xby_skill/xby-awslabs-aws-diagram
核心功能¶
插件提供四个主要工具:
- set_xby_apikey:在聊天中设置 API 密钥,设置后自动持久化,重启对话依然有效。
- generate_diagram:从 Python 代码生成图表。工具会执行传入的 Python 代码(
show=False),返回生成的 PNG 图片路径。 - get_diagram_examples:获取不同类型图表的示例代码,帮助理解
diagrams包的语法和功能。 - list_icons:列出
diagrams包中可用的图标,支持按 Provider(如 AWS)或 Service 进行过滤。
典型用法¶
使用该插件生成图表通常遵循以下步骤:
- 获取示例代码:先调用
get_diagram_examples,选择感兴趣的图表类型(如aws、sequence),学习代码结构和语法。 - 获取可用图标:调用
list_icons,查看当前可用的图标列表。这是编写代码时必须参考的权威列表。 - 编写图表代码:
- 不要手动
import图标。 - 直接以
with Diagram(开头。 - 使用
list_icons返回的图标名称,注意区分大小写。 - 遵循
diagrams包的 Python DSL 语法。 - 对于复杂图表,使用
Cluster对组件进行分组。 - 确保图表布局从左到右,左侧以用户或终端设备开始。
- 不要手动
- 生成图表:将编写好的 Python 代码发送给
generate_diagram工具。 - 注意工作目录:调用
generate_diagram时,务必确保当前工作目录已正确设置,以便生成的图片能被访问到。
注意事项¶
- 不使用导入语句:插件运行环境已经预装了所有必要的图标,不需要在代码中写
import语句。 - 工作目录参数:调用工具时必须提供正确的
workspace_dir,否则生成的图表可能无法保存到用户可访问的位置。 - 代码执行模式:生成的代码默认以
show=False模式执行,不会直接弹出显示窗口,而是返回文件路径。
生态背景¶
DeepSeek Harness (DSH) 的设计理念是「一切皆插件」。社区目录提供了丰富的插件生态,旨在解决特定开发场景的痛点。本插件与 DeepSeek 或幻方量化无官方从属关系,使用前请确保源码安全及许可证兼容。