UML-MCP-Server

UML-MCP-Server

site icon
2025.03.22 4
PythonUML 图表生成开发工具开发效率
UML-MCP Server 是一个基于 MCP(Model Context Protocol)的 UML 图表生成工具,能够通过自然语言描述或直接编写 PlantUML 代码帮助用户生成各种类型的 UML 图表。
View on GitHub

Overview

基本能力

产品定位

UML-MCP Server 是一个 UML 图表生成工具,旨在通过自然语言描述或 PlantUML 代码快速生成多种类型的 UML 图表,并支持与支持 MCP 的客户端(如 Claude)集成。

核心功能

  • 支持多种 UML 图表类型:类图、序列图、活动图、用例图、状态图、组件图、部署图、对象图
  • 通过自然语言描述生成 UML 图表
  • 直接使用 PlantUML 代码生成 UML 图表
  • 返回 PlantUML 代码和可访问的 URL 链接,便于分享和查看
  • 同时将生成的 UML 图表保存到本地,并提供本地文件路径
  • 支持自定义保存路径和指定 UML 图像的输出目录
  • 作为 MCP 服务器,可与支持 MCP 的客户端(如 Claude)集成
  • 全面的日志系统,记录服务器运行状态和操作日志

适用场景

  • 开发人员在设计阶段快速生成 UML 图表
  • 团队协作时通过自然语言描述生成 UML 图表并分享
  • 在支持 MCP 的客户端(如 Claude)中直接使用 UML 图表生成功能

工具列表

  • PlantUML 代码生成器:根据自然语言描述或直接编写的 PlantUML 代码生成 UML 图表
  • URL 生成器:生成可访问的 PlantUML URL 链接
  • 本地文件保存器:将生成的 UML 图表保存到本地文件系统

常见问题解答

  • 无法生成 UML 图表:检查日志中的错误信息,可能是网络问题或 PlantUML 服务器暂时不可用
  • 图像未保存到本地:检查“output”目录是否存在并具有写入权限
  • MCP 服务器无法启动:检查日志文件,确保没有端口冲突或其他程序错误

使用教程

使用依赖

  1. 确保已安装 Python 3.x 和 Git
  2. 创建并激活虚拟环境: bash python -m venv uml-mcp-venv source uml-mcp-venv/bin/activate # Linux/Mac # 或 uml-mcp-venv\Scripts\activate # Windows

安装教程

  1. 克隆仓库: bash git clone https://github.com/yourusername/UML-MCP-Server.git cd UML-MCP-Server
  2. 安装依赖: bash pip install -r requirements.txt

调试方式

  1. 运行服务器: bash python uml_mcp_server.py
  2. 检查日志文件以查看服务器运行状态和错误信息。

许可证

该项目遵循 MIT 开源许可条款。