UML Diagramming

🚀 UML-MCP サーバー

UML-MCP は、クラス図やシーケンス図など、さまざまな UML ダイアグラムを生成するためのツールです。自然言語による記述または直接 PlantUML コードを使用してダイアグラムを作成することができます。

🚀 クイックスタート

UML-MCP サーバーを使用することで、自然言語や PlantUML コードをもとに UML ダイアグラムを生成できます。以下に、インストール方法と使用例を示します。

✨ 主な機能

• 自然言語記述または PlantUML コードによる UML ダイアグラム生成
• Python ライブラリとしての利用が可能
• Cursor エディタでの統合使用

📦 インストール

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 ファイルを参照してください。