UML-MCP-Server

UML-MCP Server ist ein auf MCP (Model Context Protocol) basierendes Tool zur Erstellung von UML-Diagrammen, mit dem Benutzer verschiedene Arten von UML-Diagrammen durch Beschreibung in natürlicher Sprache oder durch direktes Schreiben von PlantUML-Code erstellen können.

Funktionale Merkmale

Unterstützt mehrere UML-Diagrammtypen: Klassendiagramm, Sequenzdiagramm, Aktivitätsdiagramm, Anwendungsfalldiagramm, Zustandsdiagramm, Komponentendiagramm, Bereitstellungsdiagramm, Objektdiagramm
UML-Diagramme können durch natürliche Sprachbeschreibung generiert werden
Sie können PlantUML-Code direkt verwenden, um UML-Diagramme zu generieren
Geben Sie PlantUML-Code und zugängliche URL-Links für einfaches Teilen und Anzeigen zurück
Gleichzeitiges lokales Speichern des generierten UML-Diagramms und Angabe des lokalen Dateipfads
Unterstützt benutzerdefinierte Speicherpfade und gibt das Ausgabeverzeichnis für UML-Bilder an
Als MCP-Server kann es mit Clients integriert werden, die MCP unterstützen, wie zum Beispiel Claude
Ein umfassendes Protokollierungssystem, das den Serverbetriebsstatus und die Betriebsprotokolle aufzeichnet

Installation

Installation über Smithery

So installieren Sie das UML Diagram Generation Tool für Claude Desktop automatisch über Smithery :

npx -y @smithery/cli install @Swayingleaves/uml-mcp-server --client claude

Manuelle Installation

Repository klonen:

git clone https://github.com/yourusername/UML-MCP-Server.git
cd UML-MCP-Server

Erstellen und aktivieren Sie eine virtuelle Umgebung:

python -m venv uml-mcp-venv
source uml-mcp-venv/bin/activate  # Linux/Mac
# Or
uml-mcp-venv\Scripts\activate  # Windows

Installieren Sie Abhängigkeiten:

pip install -r requirements.txt

Verwendungsmethode

Wird als Python-Bibliothek verwendet

from fix_plantuml import generate_uml

# Create UML code
uml_code = """
@startuml
Title: Simple Class Diagram

class User {
-String name
-String email
+login()
+logout()
}

class Order {
-int id
-Date date
+process()
}

User "1" -- "many" Order: places
@enduml
"""

# Generate URLs, code, and local paths for UML diagrams
result = generate_uml(uml_code)

# Output result
print("PlantUML code: ")
print(result["code"])
print("\nPlantUML URL:")
print(result["url"])
print("\nLocal file path: ")
print(result["local_path"])

MCP im Cursor konfigurieren

Der Cursor unterstützt MCP-Server (Model Context Protocol), sodass Sie UML-Diagramme direkt mithilfe des UML-MCP-Servers im Cursor erstellen können. Die Konfigurationsschritte sind wie folgt:

Stellen Sie sicher, dass die neueste Version von Cursor IDE (die die MCP-Funktionalität unterstützt) installiert ist.
Öffnen Sie die Konfigurationsdatei von Cursor:

Unter macOS: ~/Library/Application Support/Cursor/config.json
Unter Windows: %APPDATA%\Cursor\config.json
Unter Linux: ~/.config/Cursor/config.json

Fügen Sie den Abschnitt „mcpServer“ in der Konfigurationsdatei hinzu oder ändern Sie ihn:

{
    "mcpServers": {
        "UML-MCP-Server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/yourpath/UML-MCP-Server",
                "run",
                "uml_mcp_server.py"
            ],
            "output_dir": "/Users/yourpath/uml-output"
        }
    }
}

Konfigurationsbeschreibung:

UML-MCP-Server: Der Name des MCP-Servers kann bei Bedarf geändert werden
Befehl: Verwenden Sie UV als laufenden Befehl
args :
- Verzeichnis: Geben Sie den absoluten Pfad des Projektverzeichnisses an
- run : Führen Sie den Befehl aus
- uml_mcp_server.py: Hauptprogrammdatei
output_dir : Geben Sie das Ausgabeverzeichnis für UML-Bilder an

Bitte ändern Sie den folgenden Pfad entsprechend Ihrer tatsächlichen Situation:

Ersetzen Sie '/Users/Yourpath/UML-MCP Server' durch den tatsächlichen Pfad Ihres UML-MCP-Serverprojekts
Ersetzen Sie '/Users/Yourpath/uml-output' durch den Verzeichnispfad, in dem Sie das UML-Bild speichern möchten

Speichern Sie die Konfigurationsdatei und starten Sie den Cursor neu.
UML-MCP-Server im Cursor verwenden:

Öffnen Sie ein neues Chatfenster
In der Symbolleiste unten in der Chat-Oberfläche sehen Sie das Symbol "UML-MCP Server"
Klicken Sie auf dieses Symbol, um das Optionsmenü für UML-Tools anzuzeigen.
Wählen Sie den gewünschten UML-Diagrammtyp aus (z. B. „Klassendiagramm generieren“, „Sequenzdiagramm generieren“ usw.).

Verwenden von UML-Tools im Cursor

Im Cursor können Sie Folgendes eingeben:

Zum Beispiel:

Understand the certification process of the project
Generate UML code for the authentication process and generate a flowchart through UML-MCP Server
Attention: "output_dir": "/Users/my-project/uml-output"

Die von UML-Tools zurückgegebenen Ergebnisse

Unabhängig davon, wie UML-Tools verwendet werden, ruft Cursor den UML-MCP-Server auf und gibt Folgendes zurück:

PlantUML-Code – Sie können diesen Code kopieren, um ihn in anderen PlantUML-Tools zu verwenden
PlantUML-URL – Sie können diese URL in einem Browser öffnen, um das generierte UML-Diagramm anzuzeigen
Lokaler Dateipfad - Das generierte UML-Bild wird in diesem lokalen Pfad gespeichert

Zum Beispiel:

Class diagram generated:

PlantUML code:
@startuml
Title: User and Order System
class User {
-String name
-String email
+login()
+logout()
}
class Order {
-int id
-Date date
+process()
}
User "1" -- "many" Order: places
@enduml

PlantUML URL：
http://www.plantuml.com/plantuml/png/~1UDgCqB5Bn0G1k1zYWM_EfPYQYY0Qd9oQc9oQaPcKYYcKc9gMYaiKc9gK...

Local file path:
/Users/username/projects/UML-MCP-Server/output/class_diagram_12345.png

Sie können das generierte UML-Diagramm auf folgende Arten anzeigen:

Klicken Sie auf den zurückgegebenen URL-Link, um ihn im Browser anzuzeigen
Öffnen Sie den lokalen Dateipfad im Dateibrowser, um das gespeicherte Bild anzuzeigen
In Cursor können Sie Markdown-Syntax verwenden, um Bilder direkt im Chatfenster anzuzeigen

Fehlerbehebung

Wenn bei der Verwendung des UML-MCP-Servers Probleme auftreten, können Sie die folgenden Schritte versuchen:

Überprüfen Sie die Protokolldateien : Sehen Sie sich die Protokolldateien im Verzeichnis „logs“ an, um Fehlerdetails zu erhalten
Installation der Abhängigkeiten überprüfen : Stellen Sie sicher, dass alle Abhängigkeiten korrekt installiert sind
Überprüfen Sie die Netzwerkverbindung : Stellen Sie sicher, dass auf den PlantUML-Server ( www.plantuml.com ) zugegriffen werden kann
Überprüfen Sie die Berechtigungen des Ausgabeverzeichnisses : Stellen Sie sicher, dass das Programm die Berechtigung hat, in das Verzeichnis „Ausgabe“ zu schreiben

Häufige Probleme und Lösungen:

UML-Diagramm kann nicht generiert werden: Suchen Sie im Protokoll nach Fehlermeldungen, die möglicherweise auf Netzwerkprobleme oder eine vorübergehende Nichtverfügbarkeit des PlantUML-Servers zurückzuführen sind
Bild nicht lokal gespeichert : Überprüfen Sie, ob das Verzeichnis „Ausgabe“ vorhanden ist und über Schreibberechtigung verfügt
MCP-Server kann nicht gestartet werden: Überprüfen Sie die Protokolldatei, um sicherzustellen, dass keine Portkonflikte oder andere Programmfehler vorliegen

Beitrag

Tragen Sie gerne Code bei, melden Sie Probleme oder machen Sie Verbesserungsvorschläge! Beteiligen Sie sich bitte über GitHub Issues oder Pull Requests an der Projektentwicklung.

Lizenz

Dieses Projekt verwendet die MIT-Lizenz. Weitere Informationen finden Sie im Lizenzdokument.

UML-MCP Server

Integrations