Skip to main content
Glama
Malnati

vaults-diagram-tools

by Malnati

vaults-diagram-tools

CI Release License: MIT Node.js >=20.11 Docs Container

用于 SVG/JPEG 渲染、离线资源和 MCP 工作流的便携式 Mermaid 及源代码图表工具包。

包含内容

  • 从 Vaults 工具链中提取的 Mermaid 渲染器。

  • 源代码转 Mermaid 图表生成器。

  • 带有三个显式工具的 MCP stdio 服务器。

  • 用于 zip 和容器分发的离线可用发布资源。

  • 适用于 Homebrew、deb/rpm、VS Code、CDN、Docker 和 Podman 的打包模板。

不包含:OCR/文档转换、Claro 库审计、CPQ 导入、剪辑或 Casa Conectada PDF 工具。

Related MCP server: MCP Mermaid Image Gen

安装

来自 GitHub 的 npm 包

npm install github:malnati/vaults-diagram-tools

本地检出

git clone https://github.com/malnati/vaults-diagram-tools.git
cd vaults-diagram-tools
npm ci
npm test

容器

docker build -f containers/Containerfile -t vaults-diagram-tools:local .
podman build -f containers/Containerfile -t vaults-diagram-tools:local .

发布镜像已发布至 GitHub Container Registry,地址为 ghcr.io/malnati/vaults-diagram-tools。

命令行使用

vaults-mermaid-render path/to/diagram.mmd --output-dir out --png --ascii --manifest out/manifest.json
vaults-source-diagrams --source-dir src --output-dir diagrams --langs auto --diagrams dependency,class
vaults-diagram-mcp

本地检出等效命令:

node packages/renderer/render-mermaid-assets.mjs examples/simple/flowchart.mmd --output-dir /tmp/vaults-diagram-tools
node packages/source-diagrams/source-diagrams.mjs --source-dir packages/source-diagrams/tests/fixtures/js-project --output-dir /tmp/source-diagrams
node packages/mcp/server.mjs

支持的公共 CLI 为上述三个命令。额外的包二进制文件是针对旧版 Vaults 路径的兼容性入口点,可能会在未来的主要版本中弃用。

MCP 工具

vaults-diagram-mcp 仅公开三个工具:

  • render_mermaid_text

  • render_mermaid_file

  • generate_source_diagrams

Markdown 图表策略

生成的 Markdown 应链接工件并在 mermaid 代码块中显示源代码:

#### Diagram title
- Links: [Mermaid source](assets/diagram.mmd) / [SVG](assets/diagram.svg) / [JPEG](assets/diagram.jpg)

```mermaid
flowchart TD
  A --> B
```

SVG 和 JPEG 文件是交付工件。Markdown 应链接它们,而不是默认将它们作为图像嵌入。

离线供应商运行时

源代码树不提交 node_modules。构建和发布作业通过以下方式创建离线供应商资源:

npm run vendor:refresh
npm run test:vendor:offline

渲染器可以在开发期间从常规 npm 依赖项运行,或者在 MMDC_VENDOR_ONLY=1 时从 packages/renderer/vendor/node 运行。

分发状态

v1 版本中已实现:

  • npm 包元数据和 GitHub 安装流程

  • Docker/Podman 镜像

  • MCP 服务器

  • zip 发布

  • GitHub Actions CI、发布、CodeQL 和 Pages 工作流

v1 版本中的模板:

  • Homebrew 公式

  • 通过 nfpm 实现的 deb/rpm

  • VS Code 扩展 shell

  • 一旦启用 npm 发布,通过 npm/jsDelivr/unpkg 实现的 CDN 外观

文档

Related MCP Connectors

Related MCP Servers