UML-MCP: A Diagram Generation Server with MCP Interface

UML-MCP: A Diagram Generation Server with MCP Interface

site icon
2025.04.12 5
Python图表生成UML 工具开发工具开发效率
UML-MCP 是一个基于 Model Context Protocol (MCP) 的图表生成服务器,能够直接从 AI 助手和其他应用程序无缝创建各种类型的图表。它支持多种图表类型,包括 UML 图表(类图、序列图、活动图等)、Mermaid、D2 等,并提供多种输出格式(SVG、PNG、PDF 等)。UML-MCP 通过 MCP 协议与支持该协议的 LLM 助手集成,适用于开发人员、设计师和需要快速生成图表的用户。
View on GitHub

Overview

基本能力

产品定位

UML-MCP 是一个强大的图表生成服务器,专注于通过 MCP 协议提供多种图表生成能力,适用于开发人员和设计师。

核心功能

  • 多种图表类型支持:包括 UML 图表(类图、序列图、活动图等)、Mermaid、D2、Graphviz、ERD 等。
  • MCP 集成:与支持 MCP 协议的 LLM 助手无缝集成。
  • 多种输出格式:支持 SVG、PNG、PDF 等格式。
  • 易于配置:可与本地或远程图表渲染服务配合使用。

适用场景

  • 开发人员在编写代码时快速生成 UML 图表。
  • 设计师需要快速创建和修改图表。
  • 团队协作中需要共享和讨论图表。

工具列表

  • Universal UML Generator:生成任何 UML 图表。
  • Specific UML Diagram Tools:生成特定类型的 UML 图表(如类图、序列图等)。
  • Other Diagram Formats:支持 Mermaid、D2、Graphviz 等其他图表格式。

常见问题解答

  • 如何配置本地 PlantUML 或 Kroki 服务器? 使用 Docker 运行本地服务器并设置相应的环境变量。
  • 如何调试服务器? 使用 --debug 参数运行服务器,日志将存储在 logs/ 目录中。

使用教程

使用依赖

  • Python 3.10 或更高版本
  • pip(Python 包安装工具)

安装教程

  1. 克隆仓库:
git clone https://github.com/yourusername/uml-mcp.git
cd uml-mcp
  1. 安装依赖:
pip install -r requirements.txt
  1. 开发环境安装:
pip install -r requirements-dev.txt

运行服务器

python mcp_server.py

调试方式

python mcp_server.py --debug

配置本地服务器

  1. 启动 PlantUML 服务器:
docker run -d -p 8080:8080 plantuml/plantuml-server
  1. 启动 Kroki 服务器:
docker run -d -p 8000:8000 yuzutech/kroki
  1. 设置环境变量:
export USE_LOCAL_PLANTUML=true
export PLANTUML_SERVER=http://localhost:8080
export USE_LOCAL_KROKI=true
export KROKI_SERVER=http://localhost:8000

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。