Uml MCP Server

🚀 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 圖表，並根據需要進行定製和擴展。