UML-MCP-Server

English | 中文

UML-MCP Server is a UML diagram generation tool based on MCP (Model Context Protocol), which can help users generate various types of UML diagrams through natural language description or directly writing PlantUML code.

Functional Features

• Supports multiple UML diagram types: class diagram, sequence diagram, activity diagram, use case diagram, state diagram, component diagram, deployment diagram, object diagram
• UML diagrams can be generated through natural language description
• You can directly use PlantUML code to generate UML diagrams
• Return PlantUML code and accessible URL links for easy sharing and viewing
• Simultaneously save the generated UML diagram locally and provide the local file path
• Support custom save path and specify the output directory for UML images
• As an MCP server, it can integrate with clients that support MCP, such as Claude
• A comprehensive logging system that records server operating status and operation logs

Installation

Installing via Smithery

To install UML Diagram Generation Tool for Claude Desktop automatically via Smithery:

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

Manual Installation

1. Clone repository:

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

2. Create and activate a virtual environment:

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

3. Install dependencies:

pip install -r requirements.txt

Usage Method

Used as a Python Library

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"])

Configure MCP in Cursor

The Cursor supports MCP (Model Context Protocol) servers, allowing you to directly generate UML diagrams using UML-MCP Server in the Cursor. The configuration steps are as follows:

1. Ensure that the latest version of Cursor IDE (which supports MCP functionality) is installed.

2. Open the configuration file of Cursor:

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

3. Add or modify the 'mcpServer' section in the configuration file:

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

Configuration Description:

• UML-MCP-Server: The name of the MCP server can be modified as needed
• Command: Use UV as the running command
• args:
  • directory: Specify the absolute path of the project directory
  • run: Run the command
  • uml_mcp_server.py: Main program file
• output_dir: Specify the output directory for UML images

Please modify the following path according to your actual situation:

• Replace '/Users/Yourpath/UML-MCP Server' with the actual path of your UML-MCP Server project
• Replace '/Users/Yourpath/uml-output' with the directory path where you want to save the UML image

4. Save the configuration file and restart the Cursor.

... View full README on GitHub