vaults-diagram-tools

Tragbares Mermaid- und Quellcode-Diagramm-Toolkit für SVG/JPEG-Rendering, Offline-Assets und MCP-Workflows.

Was ist enthalten

• Mermaid-Renderer, extrahiert aus der Vaults-Toolchain.

• Generator für Quellcode-zu-Mermaid-Diagramme.

• MCP-stdio-Server mit drei expliziten Tools.

• Offline-fähige Release-Assets für Zip- und Container-Distribution.

• Paketierungsvorlagen für Homebrew, deb/rpm, VS Code, CDN, Docker und Podman.

Nicht enthalten: OCR/Dokumentenkonvertierung, Claro-Vault-Audits, CPQ-Import, Clippings oder Casa Conectada PDF-Tools.

Installation

npm-Paket von GitHub

npm install github:malnati/vaults-diagram-tools

Lokaler Checkout

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

Container

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

Release-Images werden in der GitHub Container Registry unter ghcr.io/malnati/vaults-diagram-tools veröffentlicht.

Befehlszeilennutzung

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

Äquivalente für den lokalen Checkout:

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

Die unterstützten öffentlichen CLIs sind die drei oben genannten Befehle. Zusätzliche Paket-Binärdateien sind Kompatibilitäts-Einstiegspunkte für ältere Vaults-Pfade und könnten in einem zukünftigen Major-Release als veraltet markiert werden.

MCP-Tools

vaults-diagram-mcp stellt genau drei Tools bereit:

• render_mermaid_text

• render_mermaid_file

• generate_source_diagrams

Richtlinie für Markdown-Diagramme

Generiertes Markdown sollte Artefakte verlinken und den Quellcode in einem mermaid-Block anzeigen:

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

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

SVG- und JPEG-Dateien sind Bereitstellungsartefakte. Markdown sollte diese standardmäßig verlinken, anstatt sie als Bilder einzubetten.

Offline-Vendor-Laufzeit

Der Quellbaum enthält kein node_modules. Build- und Release-Jobs erstellen Offline-Vendor-Assets mit:

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

Der Renderer kann während der Entwicklung mit normalen npm-Abhängigkeiten oder bei MMDC_VENDOR_ONLY=1 aus packages/renderer/vendor/node ausgeführt werden.

Distributionsstatus

Funktioniert in v1:

• npm-Paket-Metadaten und GitHub-Installationsablauf

• Docker/Podman-Image

• MCP-Server

• Zip-Release

• GitHub Actions CI, Release, CodeQL und Pages-Workflows

Vorlagen in v1:

• Homebrew-Formel

• deb/rpm über nfpm

• VS Code-Erweiterungs-Shell

• CDN-Fassade über npm/jsDelivr/unpkg, sobald die npm-Veröffentlichung aktiviert ist

Dokumentation

• GitHub Pages-Dokumentation

• Vaults-Kompatibilitätshinweise

• Beitragsleitfaden

• Sicherheitsrichtlinie