UML Diagramming

🚀 UML-MCP 服务器

UML-MCP 是一款强大的工具，可用于生成多种 UML 图表，如类图、序列图等。它支持两种创建图表的方式，既可以通过自然语言描述，也能直接使用 PlantUML 代码。

🚀 快速开始

UML-MCP 服务器为用户提供了便捷的 UML 图表生成功能，下面将详细介绍它的安装与使用方法。

✨ 主要特性

• 支持通过自然语言描述或直接使用 PlantUML 代码创建多种 UML 图表。
• 使用后可返回 PlantUML 代码、PlantUML URL 和本地文件路径，方便进一步使用和查看。

📦 安装指南

使用 Smithery 安装

可以通过以下命令使用 Smithery 进行安装：

smith install uml-mcp-server

手动安装

1. 克隆此仓库：

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

2. 创建并激活虚拟环境（推荐）：
   • 在 Linux/Mac 上：

   python3 -m venv env
   source env/bin/activate
   

   • 在 Windows 上：

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

3. 安装依赖项：

pip install -r requirements.txt

💻 使用示例

基础用法

作为 Python 库使用

将 uml_mcp_server 模块导入到您的 Python 脚本中，并调用相关函数来生成图表。例如：

from uml_mcp_server import generate_class_diagram

# 通过自然语言描述生成类图
diagram = generate_class_diagram("用户和订单系统")
print(diagram)

在 Cursor 中使用

1. 配置 cursor.json 文件，添加以下内容：

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

2. 在 Cursor 中使用 UML 工具生成图表，例如：
   • 输入自然语言描述：

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

   • 查看生成的 UML 代码和图表。

高级用法

无论使用哪种方式，UML 工具都会返回以下内容：

1. PlantUML 代码：可以直接复制到其他 PlantUML 工具中使用。
2. PlantUML URL：打开该链接可以在浏览器中查看生成的 UML 图表。
3. 本地文件路径：图表保存在指定的输出目录中。

例如：

类图已生成：

PlantUML 代码：
@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...

本地文件路径：
/Users/username/projects/uml-mcp-server/output/class_diagram_12345.png

🔧 技术细节

故障排除

• 无法生成 UML 图表：检查错误日志以获取详细信息。
• 图像未保存到本地：确保输出目录存在且有写入权限。
• MCP 服务器无法启动：检查是否有端口冲突或其他程序错误。

贡献

欢迎通过 GitHub Issues 或 Pull Requests 提交代码、报告问题或提出改进建议！

📄 许可证

该项目采用 MIT 许可证。详细信息请参阅 LICENSE 文件。