UML-MCP：带有 MCP 接口的图表生成服务器

UML-MCP 是一个强大的图表生成服务器，它实现了模型上下文协议 (MCP)，可以直接从 AI 助手和其他应用程序创建无缝图表。

🌟 特性

• 多种图表类型：支持 UML 图（类图、时序图、活动图等）、Mermaid、D2 等
• MCP 集成：与支持模型上下文协议的 LLM 助手无缝集成
• Playground 链接：每个图表类型的在线编辑器直接链接
• 多种输出格式：SVG、PNG、PDF 和其他格式选项
• 易于配置：适用于本地和远程图表渲染服务

📋 支持的图表类型

UML-MCP 支持各种图表类型：

类别	图表类型
UML	类图、时序图、活动图、用例图、状态图、组件图、部署图、对象图
其他	Mermaid、D2、Graphviz、ERD、BlockDiag、BPMN、使用 PlantUML 的 C4

🚀 快速开始

前提条件

• Python 3.10 或更高版本
• pip (Python 包安装程序)

安装

1. 克隆存储库：

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

2. 安装依赖项：

pip install -r requirements.txt

3. 对于开发环境：

pip install -r requirements-dev.txt

运行服务器

启动 MCP 服务器：

python mcp_server.py

这将启动服务器，使用 stdio 与 MCP 客户端进行通信。

🔧 配置

编辑器集成

Cursor

要与 Cursor 集成：

python mcp/install_to_cursor.py

或者在 Cursor 设置中手动配置：

"mcpServers": {
  "UML-MCP-Server": {
    "command": "python",
    "args": ["/path/to/uml-mcp/mcp_server.py"],
    "output_dir": "/path/to/output"
  }
}

环境变量

• MCP_OUTPUT_DIR - 保存生成的图表的目录（默认：./output）
• KROKI_SERVER - Kroki 服务器的 URL（默认：https://kroki.io）
• PLANTUML_SERVER - PlantUML 服务器的 URL（默认：http://plantuml-server:8080）
• USE_LOCAL_KROKI - 使用本地 Kroki 服务器（true/false）
• USE_LOCAL_PLANTUML - 使用本地 PlantUML 服务器（true/false）

📚 文档

有关详细文档，请访问 docs 目录或我们的 文档站点。

🧩 架构

UML-MCP 采用模块化架构构建：

• MCP 服务器核心：处理 MCP 协议通信
• 图表生成器：支持不同的图表类型
• 工具：通过 MCP 公开图表生成功能
• 资源：为各种图表类型提供模板和示例

🛠️ 本地开发

对于本地开发：

1. 设置本地 PlantUML 和/或 Kroki 服务器：

# PlantUML
docker run -d -p 8080:8080 plantuml/plantuml-server

# Kroki
docker run -d -p 8000:8000 yuzutech/kroki

2. 配置环境变量：

export USE_LOCAL_PLANTUML=true
export PLANTUML_SERVER=http://localhost:8080
export USE_LOCAL_KROKI=true  
export KROKI_SERVER=http://localhost:8000

🤝 贡献

欢迎贡献！请随时提交 Pull Request。

📄 许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。

👏 鸣谢

• PlantUML - UML 图表生成
• Kroki - 统一的图表生成服务
• Mermaid - 从文本生成图表
• D2 - 现代图表脚本语言

UML-MCP 服务器

一个 MCP 服务器，通过各种图表渲染引擎提供 UML 图表生成功能。

组件

资源

服务器通过 uml:// URI 方案提供多个资源：

• uml://types：可用 UML 图表类型的列表
• uml://templates：用于创建 UML 图表的模板
• uml://examples：用于参考的 UML 图表示例
• uml://formats：支持的图表输出格式
• uml://server-info：有关 UML-MCP 服务器的信息

工具

服务器实现了多个图表生成工具：

通用 UML 生成器

• generate_uml：生成任何 UML 图表
  • 参数：diagram_type、code、output_dir

特定 UML 图表工具

• generate_class_diagram：生成 UML 类图
  • 参数：code、output_dir
• generate_sequence_diagram：生成 UML 时序图
  • 参数：code、output_dir
• generate_activity_diagram：生成 UML 活动图
  • 参数：code、output_dir
• generate_usecase_diagram：生成 UML 用例图
  • 参数：code、output_dir
• generate_state_diagram：生成 UML 状态图
  • 参数：code、output_dir
• generate_component_diagram：生成 UML 组件图
  • 参数：code、output_dir
• generate_deployment_diagram：生成 UML 部署图
  • 参数：code、output_dir
• generate_object_diagram：生成 UML 对象图
  • 参数：code、output_dir

其他图表格式

• generate_mermaid_diagram：使用 Mermaid 语法生成图表
  • 参数：code、output_dir
• generate_d2_diagram：使用 D2 语法生成图表
  • 参数：code、output_dir
• generate_graphviz_diagram：使用 Graphviz DOT 语法生成图表
  • 参数：code、output_dir
• generate_erd_diagram：生成实体关系图
  • 参数：code、output_dir

提示

服务器提供提示以帮助创建 UML 图表：

• class_diagram：创建一个 UML 类图，显示类、属性、方法和关系
• sequence_diagram：创建一个 UML 时序图，显示对象之间随时间的交互
• activity_diagram：创建一个 UML 活动图，显示工作流程和业务流程

配置

安装

Claude Desktop

在 MacOS 上：~/Library/Application\ Support/Claude/claude_desktop_config.json 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

<details> <summary>Claude Desktop 配置</summary>

{
  "mcpServers": {
    "uml_diagram_generator": {
      "command": "python",
      "args": [
        "/path/to/uml-mcp/mcp_server.py"
      ]
    }
  }
}

</details>

Cursor 集成

UML-MCP 服务器也可以与 Cursor 集成：

<details> <summary>Cursor 配置</summary>

{
  "mcpServers": {
    "uml_diagram_generator": {
      "command": "python",
      "args": [
        "/path/to/uml-mcp/mcp_server.py"
      ]
    }
  }
}

</details>

用法

命令行参数

usage: mcp_server.py [-h] [--debug] [--host HOST] [--port PORT] [--transport {stdio,http}] [--list-tools]

UML-MCP 图表生成服务器

options:
  -h, --help            显示此帮助消息并退出
  --debug               启用调试日志记录
  --host HOST           服务器主机（默认：127.0.0.1）
  --port PORT           服务器端口（默认：8000）
  --transport {stdio,http}
                        传输协议（默认：stdio）
  --list-tools          列出可用工具并退出

环境变量

• LOG_LEVEL：设置日志记录级别（DEBUG、INFO、WARNING、ERROR、CRITICAL）
• UML_MCP_OUTPUT_DIR：用于存储生成的图表文件的目录
• KROKI_SERVER：用于图表渲染的 Kroki 服务器 URL
• PLANTUML_SERVER：用于图表渲染的 PlantUML 服务器 URL
• LIST_TOOLS：设置为 "true" 以显示工具并退出

示例：生成类图

result = tool.call("generate_class_diagram", {
    "code": """
        @startuml
        class User {
          -id: int
          -name: string
          +login(): boolean
        }
        class Order {
          -id: int
          +addItem(item: string): void
        }
        User "1" -- "many" Order
        @enduml
    """,
    "output_dir": "/path/to/output"
})

开发

构建和运行

# 克隆存储库
git clone https://github.com/your-username/uml-mcp.git
cd uml-mcp

# 安装依赖项
pip install -r requirements.txt

# 运行服务器
python mcp_server.py

调试

对于调试，您可以使用以下命令运行服务器：

python mcp_server.py --debug

调试日志将存储在 logs/ 目录中。

运行测试

# 运行所有测试
pytest

# 运行特定测试
pytest tests/test_diagram_tools.py