UML Diagramming

🚀 UML-MCP 服務器

UML-MCP 是一款強大的工具，可用於生成多種 UML 圖表，如類圖、序列圖等。它支持通過自然語言描述或直接使用 PlantUML 代碼來創建圖表，為用戶提供了便捷、高效的圖表生成體驗。

🚀 快速開始

UML-MCP 服務器能幫助你輕鬆生成各類 UML 圖表，下面將詳細介紹其安裝和使用方法。

📦 安裝指南

使用 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 文件。