Uml MCP Server

🚀 UML-MCP サーバー

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

🚀 クイックスタート

UML-MCP サーバーを使用することで、自然言語または PlantUML コードを使って UML ダイアグラムを生成できます。以下のセクションでは、インストール方法、使用方法、トラブルシューティングなどの詳細を説明します。

✨ 主な機能

1. クラス図、シーケンス図、コラボレーション図など、複数の UML ダイアグラムタイプをサポートします。
2. 自然言語記述による UML ダイアグラム生成機能を提供します。
3. PlantUML コードを直接使用したダイアグラム生成をサポートします。
4. 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
   

💻 使用例

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)

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 サーバーを使って必要な UML ダイアグラムを簡単に生成し、必要に応じてカスタマイズや拡張を行うことができます。