UML MCP服务器
UML-MCP Server是一个基于MCP（模型上下文协议）的UML图生成工具，可以帮助用户通过自然语言描述或直接编写PlantUML代码生成各种类型的UML图。
功能特性
- 支持多种UML图类型：类图、序列图、活动图、用例图、状态图、组件图、部署图、对象图
- UML图可以通过自然语言描述生成
- 您可以直接使用PlantUML代码生成UML图
- 返回PlantUML代码和可访问的URL链接，便于共享和查看
- 同时将生成的UML图保存在本地并提供本地文件路径
- 支持自定义保存路径，并指定UML图像的输出目录
- 作为MCP服务器，它可以与支持MCP的客户端集成，如Claude
- 一个全面的日志系统，记录服务器运行状态和操作日志
安装
通过Smithery安装
通过以下方式自动安装Claude Desktop的UML图生成工具 史密瑟里:
npx -y @smithery/cli install @Swayingleaves/uml-mcp-server --client claude手动安装
- 克隆存储库：
git clone https://github.com/yourusername/UML-MCP-Server.git
cd UML-MCP-Server- 创建并激活虚拟环境：
python -m venv uml-mcp-venv
source uml-mcp-venv/bin/activate # Linux/Mac
# Or
uml-mcp-venv\Scripts\activate # Windows- 安装依赖项：
pip install -r requirements.txt使用方法
用作Python库
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
Cursor支持MCP（模型上下文协议）服务器，允许您在Cursor中使用UML-MCP服务器直接生成UML图。配置步骤如下：
- 确保安装了最新版本的Cursor IDE（支持MCP功能）。
- 打开Cursor的配置文件：
- 在macOS上：
~/Library/Application Support/Cursor/config.json - 在Windows上：
%APPDATA%\Cursor\config.json - 在Linux上：
~/.config/Cursor/config.json
- 在配置文件中添加或修改“mcpServer”部分：
{
"mcpServers": {
"UML-MCP-Server": {
"command": "uv",
"args": [
"--directory",
"/Users/yourpath/UML-MCP-Server",
"run",
"uml_mcp_server.py"
],
"output_dir": "/Users/yourpath/uml-output"
}
}
}配置说明：
- UML MCP服务器：可以根据需要修改MCP服务器的名称
- 命令：使用UV作为运行命令
args:
- directory：指定项目目录的绝对路径 - run：运行命令 - uml_mcp_server.py：主程序文件
output_dir：指定UML映像的输出目录
请根据您的实际情况修改以下路径：
- 将“/Users/Yourpath/UML-MCP服务器”替换为UML-MCP服务器项目的实际路径
- 将“/Users/Yourpath/uml-output”替换为要保存uml映像的目录路径
- 保存配置文件并重新启动游标。
- 在游标中使用UML-MCP服务器：
- 打开一个新的聊天窗口
- 在聊天界面底部的工具栏中，您将看到“UML-MCP服务器”工具图标
- 点击此图标将打开UML工具的选项菜单
- 选择您需要的UML图类型（如“生成类图”、“生成序列图”等）
在游标中使用UML工具
在光标中，您可以输入：
例如：
1. Understand the certification process of the project
2. Generate UML code for the authentication process and generate a flowchart through UML-MCP Server
3. Attention: "output_dir": "/Users/my-project/uml-output"UML工具返回的结果
无论如何使用UML工具，Cursor都会调用UML MCP服务器并返回以下内容：
- PlantUML代码 -您可以复制此代码以在其他PlantUML工具中使用
- PlantUML URL-您可以在浏览器中打开此URL以查看生成的UML图
- 本地文件路径 -生成的UML映像保存在此本地路径中
例如：
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您可以通过以下方式查看生成的UML图：
- 点击返回的URL链接在浏览器中查看
- 在文件浏览器中打开本地文件路径以查看保存的图像
- 在Cursor中，您可以使用Markdown语法直接在聊天窗口中显示图像
故障排除
如果在使用UML-MCP服务器时遇到问题，可以尝试以下步骤：
- 检查日志文件：查看'logs'目录中的日志文件以了解错误详细信息
- 验证依赖关系安装：确保所有依赖项都已正确安装
- 检查网络连接：确保可以访问PlantUML服务器（www.PlantUML.com）
- 检查输出目录权限：确保程序有权写入“output”目录
常见问题及解决方法：
- 无法生成UML图：检查日志中的错误消息，这可能是由于网络问题或PlantUML服务器暂时不可用造成的
- 图像未保存在本地：检查'output'目录是否存在并具有写入权限
- MCP服务器无法启动：请检查日志文件，确保没有端口冲突或其他程序错误
贡献
欢迎贡献代码、报告问题或提供改进建议！请通过GitHub Issues或Pull Requests参与项目开发。
许可证
该项目采用MIT许可证。请参阅许可证文档了解详细信息。