diagrams-mcp

Beschreibung

diagrams-mcp ist ein MCP, das die automatische Generierung von Diagrammen aus Text oder JSON-Strukturen ermöglicht. Aktuell werden unterstützt:

• Klassendiagramme (UML)

• Entity-Relationship-Diagramme (ER)

• Generierung durch natürliche Sprache

• Export als SVG unter Verwendung von Mermaid

• Integration für MCP-Agenten konzipiert

Das Ziel ist es, einem Agenten oder Benutzer zu ermöglichen, ein System zu beschreiben und das entsprechende Diagramm zu erhalten, ohne Mermaid manuell schreiben zu müssen.

Installation

1. Repository klonen

git clone https://github.com/nacho-mazzoni/diagrams-mcp.git
cd diagrams-mcp

2. Abhängigkeiten installieren

npm install

3. Mermaid CLI installieren (falls nicht bereits installiert)

npm install -g @mermaid-js/mermaid-cli

4. Installation überprüfen

mmdc -h

Verwendung

Dieses MCP ist für die Zusammenarbeit mit einem Agenten konzipiert. Der empfohlene Ablauf ist:

1. Den Agenten bitten, den Projektcode zu analysieren.

2. Den Agenten auffordern, ein JSON zu generieren mit:

   • Erkannten Klassen

   • Entitäten

   • Attributen

   • Beziehungen

   • Vorgenommenen Änderungen

3. Dieses JSON direkt an das MCP übergeben.

4. Das MCP generiert automatisch das entsprechende Diagramm.

Dies ermöglicht es, das Diagramm basierend auf dem tatsächlichen Zustand des Codes oder den vom Agenten vorgenommenen Änderungen zu erstellen, ohne Mermaid manuell schreiben zu müssen.

Das MCP akzeptiert:

• Vom Agenten generiertes strukturiertes JSON

• Natürliche Sprache zur Beschreibung des Modells

• Teilweise Daten zur Aktualisierung bestehender Diagramme

Integration mit einem Agenten

Ein Benutzer kann diagrams-mcp in seinen Agenten integrieren, indem er diesem Ablauf folgt:

1. Der Benutzer fordert den Agenten auf, den Code zu analysieren oder ein System zu beschreiben.

2. Der Agent generiert ein strukturiertes JSON mit Entitäten, Klassen, Attributen und Beziehungen.

3. Der Agent sendet dieses JSON an das MCP.

4. diagrams-mcp generiert das Diagramm automatisch.

5. Der Agent gibt das generierte SVG an den Benutzer zurück.

Konzeptioneller Ablauf:

Usuario -> Agente -> JSON -> diagrams-mcp -> SVG -> Usuario

Dies ermöglicht es, dass das Diagramm den tatsächlichen Zustand des Codes oder die vom Agenten vorgenommenen Änderungen widerspiegelt.

Beispiel für ein vom Agenten generiertes JSON

{
  "entities": [
    { "name": "Usuario", "attributes": ["id", "nombre"] },
    { "name": "Pedido", "attributes": ["id", "fecha"] }
  ],
  "relations": [
    {
      "from": "Usuario",
      "to": "Pedido",
      "fromCard": "1",
      "toCard": "1..*",
      "label": "realiza"
    }
  ]
}

Dieses JSON wird direkt an das MCP übergeben, um das Diagramm zu generieren.

Projektstruktur

diagrams-mcp
│
├── tools
│   ├── classDiagram.js
│   └── erDiagram.js
│
├── parsers
│   ├── textToClass.js
│   └── textToER.js
│
├── index.js
└── package.json

Projektziel

• Integration mit MCP-Agenten

• Automatische Diagrammgenerierung während der Entwicklung

• Unterstützung für natürliche Sprache

• Zukünftige Erweiterung auf weitere Diagrammtypen

Aktueller Status

• ER-Diagramme mit Kardinalität sowie PK- und FK-Schlüsseln

• UML-Klassendiagramme

• Parser für Text

• SVG-Export

Erläuterungen

Das MCP unterstützt auch die Definition von Entitäten mit Attributen, Primärschlüsseln (PK) und Fremdschlüsseln (FK) durch Textblöcke, die durch Leerzeilen getrennt sind, was die Generierung vollständiger ER-Diagramme aus strukturierten Beschreibungen ermöglicht.