Uml MCP Server

🚀 UML-MCP Server

UML-MCP Server is a UML diagram generation tool based on the MCP protocol. It supports generating various types of UML diagrams, including class diagrams and sequence diagrams, through natural language descriptions or direct use of PlantUML code.

🚀 Quick Start

UML-MCP Server is a powerful tool for generating UML diagrams. You can generate diagrams either by describing them in natural language or using PlantUML code directly. This server supports multiple types of UML diagrams and provides a series of useful features to enhance your experience.

✨ Features

1. Support for multiple UML diagram types, such as class diagrams, sequence diagrams, and collaboration diagrams.
2. Function to generate UML diagrams through natural language descriptions.
3. Direct support for generating diagrams using PlantUML code.
4. Automatic generation of PlantUML URL links for viewing diagrams in the browser.
5. Support for saving generated diagrams as local files.
6. Provision of detailed logging functionality for easy debugging and troubleshooting.
7. Support for custom output directories, allowing flexible configuration of storage locations.
8. Error handling mechanism with friendly error prompt messages.
9. Support for multi-threaded processing to improve generation efficiency.
10. Comprehensive documentation support to help users get started quickly.

📦 Installation

Installation via Smithery

npx -y @smithery/cli install

Manual Installation

1. Clone the project repository:

   git clone https://github.com/your-repository.git
   

2. Install dependencies:

   npm install
   

3. Start the server:

   npm start
   

💻 Usage Examples

Basic Usage

# Example code
from uml_mcp_server import generate_diagram

diagram_code = '''
@startuml
Title: User and Order System
class User {
    -String 名称
    -String 邮箱
    +登录()
    +注销()
}
class 订单 {
    -int 编号
    -date 日期
    +处理()
}
User "1" -- "多" 订单：下单
@enduml
'''

# Generate the diagram
result = generate_diagram(diagram_code)
print(result)

Advanced Usage

Configure the MCP Server in Cursor

1. Open the settings interface of Cursor.
2. Add the configuration information of the MCP server:
   • Name: UML-MCP Server
   • Type: UML Diagram Generation Tool
   • Address: http://localhost:3000

Use the UML Tool in Cursor

Enter the following content to generate a diagram:

1. Understand the authentication process of the project.
2. Use the UML-MCP Server to generate UML code for the authentication process and generate a flowchart.
3. Note: Set the output directory to "/Users/username/projects/UML-MCP-Server/output".

Example of Returned Results

Class diagram generated:

PlantUML code:
@startuml
Title: User and Order System
class User {
    -String 名称
    -String 邮箱
    +登录()
    +注销()
}
class 订单 {
    -int 编号
    -date 日期
    +处理()
}
User "1" -- "多" 订单：下单
@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

Troubleshooting

1. Check the log files: View the error information in the logs directory.
2. Verify dependency installation: Ensure that all dependencies are correctly installed.
3. Check network connection: Confirm that you can access the PlantUML server (www.plantuml.com).
4. Check output directory permissions: Ensure that the program has permission to write to the output directory.

Common Issues

• Unable to generate diagrams:
  • Check if the input PlantUML code is correct.
  • Ensure that the network connection is normal and you can access external services.

🤝 Contribution

We welcome forks and Pull Requests! Repository address: GitHub

By following the above steps, you can easily use the UML-MCP Server to generate the required UML diagrams and customize and expand them as needed.