UML Diagramming

🚀 UML-MCP Server

UML-MCP is a tool for generating various UML diagrams, such as class diagrams and sequence diagrams. It supports creating diagrams through natural language descriptions or by directly using PlantUML code.

🚀 Quick Start

UML-MCP Server is a powerful tool that allows users to generate various UML diagrams. You can install it via Smithery or manually, and use it as a Python library or within Cursor.

✨ Features

• Generate multiple types of UML diagrams, including class diagrams and sequence diagrams.
• Support diagram creation through natural language descriptions or direct use of PlantUML code.
• Return PlantUML code, PlantUML URL, and local file path for the generated diagrams.

📦 Installation

Install via Smithery

You can use the following command to install via Smithery:

smith install uml-mcp-server

Manual Installation

1. Clone this repository:

git clone https://github.com/yourusername/uml-mcp-server.git
cd uml-mcp-server

2. Create and activate a virtual environment (recommended):
   • On Linux/Mac:

   python3 -m venv env
   source env/bin/activate
   

   • On Windows:

   py -m venv env
   .\env\Scripts\activate
   

3. Install dependencies:

pip install -r requirements.txt

💻 Usage Examples

Basic Usage

Use as a Python Library

Import the uml_mcp_server module into your Python script and call relevant functions to generate diagrams. For example:

from uml_mcp_server import generate_class_diagram

# Generate a class diagram through natural language description
diagram = generate_class_diagram("用户和订单系统")
print(diagram)

Use in Cursor

1. Configure the cursor.json file and add the following content:

{
  "umlTools": {
    "outputDir": "/Users/yourusername/projects/uml-output",
    "plantUmlServerUrl": "http://www.plantuml.com/plantuml/png/"
  }
}

2. Use the UML tool in Cursor to generate diagrams. For example:
   • Enter a natural language description:

     1. 理解项目的认证流程
     2. 使用 UML-MCP Server 生成认证过程的类图并导出为流程图
     

   • View the generated UML code and diagrams.

Advanced Usage

Regardless of the method used, the UML tool will return the following:

1. PlantUML Code: Can be directly copied to other PlantUML tools for use.
2. PlantUML URL: Open this link to view the generated UML diagram in the browser.
3. Local File Path: The diagram is saved in the specified output directory.

For example:

Class diagram generated:

PlantUML Code:
@startuml
Title: 用户和订单系统
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

📚 Documentation

Troubleshooting

• Unable to generate UML diagrams: Check the error log for detailed information.
• Image not saved locally: Ensure that the output directory exists and has write permissions.
• MCP server fails to start: Check for port conflicts or other program errors.

Contribution

Welcome to submit code, report issues, or propose improvement suggestions through GitHub Issues or Pull Requests!

📄 License

This project is licensed under the MIT License. For detailed information, please refer to the LICENSE file.