Uml MCP

🚀 UML 図生成サーバードキュメント

UML 図生成サーバーは、UML クラス図やシーケンス図などのさまざまなチャートを生成するためのサーバーです。RESTful API を介して簡単に操作でき、拡張可能なプラグインシステムも備えています。

📦 インストール

MacOS での Claude Desktop のインストール

パス：~/Library/Application\ 支持/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "uml_diagram_generator": {
      "command": "python",
      "args": [
        "/path/to/uml-mcp/mcp_server.py"
      ]
    }
  }
}

Windows での Claude Desktop のインストール

パス：%APPDATA%/Claude/claude_desktop_config.json

🛠️ 設定

Cursor での UML 図生成サーバーの統合

{
  "mcpServers": {
    "uml_diagram_generator": {
      "command": "python",
      "args": [
        "/path/to/uml-mcp/mcp_server.py"
      ]
    }
  }
}

💻 使用例

コマンドライン引数

usage: mcp_server.py [-h] [--debug] [--host HOST] [--port PORT] [--transport {stdio,http}] [--list-tools]

UML-MCP グラフィック生成サーバー

オプション:
  -h, --help            このヘルプメッセージを表示して終了します
  --debug               デバッグログを有効にします
  --host HOST           サービスホスト (デフォルト: 127.0.0.1)
  --port PORT           サービスポート (デフォルト: 8000)
  --transport {stdio,http}
                        トランスポートプロトコル (デフォルト: stdio)
  --list-tools          すべてのツールをリスト表示して終了します

環境変数の設定

• LOG_LEVEL: ログレベルを設定します (DEBUG, INFO, WARNING, ERROR, CRITICAL)
• UML_MCP_OUTPUT_DIR: 生成されたチャートファイルを保存するディレクトリ
• KROKI_SERVER: チャートレンダリングに使用する Kroki サーバーの URL アドレス
• PLANTUML_SERVER: チャートレンダリングに使用する PlantUML サーバーの URL アドレス
• LIST_TOOLS: ツールリストを表示して終了するには "true" に設定します

例：クラス図の生成

result = tool.call("generate_class_diagram", {
    "code": """
        @startuml
        class User {
          -id: int
          -name: string
          +login(): boolean
        }
        class Order {
          -id: int
          +addItem(item: string): void
        }
        User "1" -- "many" Order
        @enduml
    """,
    "output_dir": "/path/to/output"
})

🛠️ 開発

ビルドと実行

# リポジトリをクローンする
git clone https://github.com/your-username/uml-mcp.git
cd uml-mcp

# 依存関係をインストールする
pip install -r requirements.txt

# サーバーを起動する
python mcp_server.py

デバッグモード

python mcp_server.py --debug

デバッグログは logs/ ディレクトリに保存されます。

テストコードの例

result = tool.call("generate_class_diagram", {
    "code": """
        @startuml
        class User {
          -id: int
          -name: string
          +login(): boolean
        }
        class Order {
          -id: int
          +addItem(item: string): void
        }
        User "1" -- "many" Order
        @enduml
    """,
    "output_dir": "/path/to/output"
})

📚 ドキュメント

サーバー機能の概要

• UML クラス図、シーケンス図などの複数のチャートタイプをサポートしています
• RESTful API インターフェイスを提供して、やり取りを行います
• 拡張可能なプラグインシステムで、カスタムチャート生成ロジックをサポートしています

依存関係のインストール

pip install -r requirements.txt

サーバーの起動

python mcp_server.py

デバッグ情報

• ログレベル: DEBUG, INFO, WARNING, ERROR, CRITICAL
• ログファイル: logs/debug.log

サンプルコード

# 基本的な使用法
from uml_generator import UMLGenerator

generator = UMLGenerator()
diagram_code = '''
@startuml
class User {
  -id: int
  -name: string
  +login(): boolean
}
@enduml
'''
output_path = "examples/output.png"
generator.generate(diagram_code, output_path)

高度な機能

• 複数のチャートを一括処理することができます
• 生成状態を表示するプログレスバーを提供しています
• 出力形式をカスタマイズできます (PNG, SVG, PDF)

📂 プロジェクト構造

ディレクトリの説明

.
├── uml_generator/
│   ├── __init__.py
│   ├── generator.py          # メインの生成器クラス
│   ├── plugins/              # プラグインディレクトリ
│   └── utils.py             # ユーティリティ関数
├── requirements.txt         # 依存関係管理ファイル
└── mcp_server.py            # サービス起動スクリプト

コード構造

generator.py

class UMLGenerator:
    def __init__(self):
        self.plugins = []

    def add_plugin(self, plugin):
        """カスタムプラグインを追加する"""
        self.plugins.append(plugin)

    def generate(self, code, output_path):
        """チャートを生成する"""
        pass

utils.py

import logging

def setup_logging():
    """ログシステムを設定する"""
    logging.basicConfig(
        level=logging.DEBUG,
        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
    )

📖 使用ガイド

クイックスタート

1. 依存関係をインストールする：pip install -r requirements.txt
2. 生成器を初期化する：

from uml_generator import UMLGenerator

generator = UMLGenerator()

3. チャートを生成する：

diagram_code = '''
@startuml
class User {
  -id: int
}
@enduml
'''
generator.generate(diagram_code, "output.png")

高度な設定

• カスタムプラグインを追加する：

from uml_generator.plugins.example_plugin import ExamplePlugin

generator.add_plugin(ExamplePlugin())

• ログレベルを設定する：

import logging

logging.getLogger("uml_generator").setLevel(logging.INFO)

❌ エラー処理

よくある問題

1. 依存パッケージがインストールされていない：requirements.txt を確認して再インストールしてください。
2. ログが表示されない：ログファイルの権限とパス設定が正しいことを確認してください。

エラーメッセージの例

Traceback (most recent call last):
  File "mcp_server.py", line 18, in <module>
    from uml_generator.generator import UMLGenerator
ModuleNotFoundError: No module named 'uml_generator'

🤝 貢献ガイド

コード提出の規範

• PEP8 コーディングスタイルに従ってください
• 詳細なコミットメッセージを提供してください
• 単体テストが通過することを確認してください

協力の流れ

1. プロジェクトリポジトリを Fork する
2. 機能ブランチを作成する
3. コードを提出し、リモートリポジトリに Push する
4. Pull Request を提出する