🚀 UML-MCP 服务器

UML-MCP 服务器是一款强大的 UML 图表生成工具，它基于 MCP 协议，支持通过自然语言描述或直接使用 PlantUML 代码来生成多种 UML 图表，为用户提供了便捷的图表生成体验。

🚀 快速开始

UML-MCP Server 支持多种方式生成 UML 图表，你可以通过自然语言描述，也可以直接使用 PlantUML 代码。以下是一个简单示例，展示如何使用 Python 库调用该工具生成图表：

# 示例代码
from uml_mcp_server import generate_diagram

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

# 生成图表
result = generate_diagram(diagram_code)
print(result)

✨ 主要特性

1. 多类型支持：支持多种 UML 图表类型，如类图、时序图、协作图等。
2. 自然语言生成：提供通过自然语言描述生成 UML 图表的功能。
3. PlantUML 代码支持：直接支持使用 PlantUML 代码生成图表。
4. URL 链接生成：自动生成 PlantUML URL 链接以便在浏览器中查看图表。
5. 本地文件保存：支持将生成的图表保存为本地文件。
6. 详细日志记录：提供详细的日志记录功能，便于调试和问题排查。
7. 自定义输出目录：支持自定义输出目录，灵活配置存储位置。
8. 错误处理机制：具备错误处理机制，提供友好的错误提示信息。
9. 多线程处理：支持多线程处理，提高生成效率。
10. 全面文档支持：提供全面的文档支持，帮助用户快速上手。

📦 安装指南

通过 Smithery 安装

npx -y @smithery/cli install

手动安装

1. 克隆项目仓库：

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

2. 安装依赖项：

   npm install
   

3. 启动服务器：

   npm start
   

💻 使用示例

基础用法

# 示例代码
from uml_mcp_server import generate_diagram

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

# 生成图表
result = generate_diagram(diagram_code)
print(result)

高级用法

在 Cursor 中配置 MCP 服务器

1. 打开 Cursor 的设置界面。
2. 添加 MCP 服务器的配置信息：
   • 名称：UML-MCP Server
   • 类型：UML 图表生成工具
   • 地址：http://localhost:3000

在 Cursor 中使用 UML 工具

输入以下内容以生成图表：

1. 理解项目的认证流程
2. 使用 UML-MCP 服务器生成认证过程的 UML 代码并生成流程图
3. 注意：输出目录设置为 "/Users/username/projects/UML-MCP-Server/output"

返回结果示例

类图已生成：

PlantUML 代码：
@startuml
Title: 用户和订单系统
class User {
    -String 名称
    -String 邮箱
    +登录()
    +注销()
}
class 订单 {
    -int 编号
    -date 日期
    +处理()
}
User "1" -- "多" 订单：下单
@enduml

PlantUML URL：
http://www.plantuml.com/plantuml/png/~1UDgCqB5Bn0G1k1zYWM_EfPYQYY0Qd9oQc9oQaPcKYYcKc9gMYaiKc9gK...

本地文件路径：
/Users/username/projects/UML-MCP-Server/output/class_diagram_12345.png

📚 详细文档

故障排除

1. 检查日志文件：查看 logs 目录中的错误信息。
2. 验证依赖安装：确保所有依赖项正确安装。
3. 检查网络连接：确认能够访问 PlantUML 服务器（www.plantuml.com）。
4. 检查输出目录权限：确保程序有权限写入 output 目录。

常见问题

• 无法生成图表：
  • 检查输入的 PlantUML 代码是否正确。
  • 确保网络连接正常，能够访问外部服务。

项目贡献

欢迎 fork 和提交 Pull Request！ 仓库地址：GitHub

通过以上步骤，您可以轻松使用 UML-MCP Server 生成所需的 UML 图表，并根据需要进行定制和扩展。