Comfyui

🚀 ComfyUI MCPサーバー

この軽量なPythonベースのMCP（モデルコンテキストプロトコル）サーバーは、ローカルのComfyUIインスタンスとインターフェースを持ち、AIエージェントからのリクエストに基づいて画像生成を行います。

🚀 クイックスタート

このプロジェクトを使用することで、AIエージェントはMCPプロトコルを通じてWebSocketを介してComfyUIに画像生成リクエストを送信できます。以下の機能をサポートしています。

• 柔軟なワークフロー選択（例：basic_api_test.json）
• 動的パラメータ：prompt、width、height、model
• ComfyUIから提供される画像URLの返却

✨ 主な機能

• AIエージェントがMCPプロトコルを使用して画像生成リクエストを送信できます。
• 柔軟なワークフロー選択と動的パラメータの設定が可能です。
• ComfyUIから画像URLを取得できます。

📦 インストール

前提条件

• Python 3.10+
• ComfyUI：インストールし、ローカルで実行（例：localhost:8188）
• 依存関係：requests、websockets、mcp（pipでインストール）

インストール手順

1. リポジトリをクローン：

   git clone <your-repo-url>
   cd comfyui-mcp-server
   

2. 依存関係をインストール：

   pip install requests websockets mcp
   

3. ComfyUIを起動：

• ComfyUIをインストール（ComfyUIドキュメントを参照）。
• ポート8188で実行：

  cd <ComfyUI_dir>
  python main.py --port 8188
  

4. ワークフローを準備：

• API形式のワークフローファイル（例：basic_api_test.json）をworkflows/ディレクトリに配置します。
• ComfyUIのUIを使用してワークフローをエクスポートし、開発モード設定の「保存（API形式）」を有効にします。

💻 使用例

基本的な使用法

1. MCPサーバーを起動：

   python server.py
   

   サーバーはws://localhost:9000で待機します。

2. テストクライアントを使用：

   python client.py
   

   サンプルリクエストとして、「a dog wearing sunglasses」、512x512のサイズ、sd_xl_base_1.0.safetensorsモデルを使用します。 出力例：

   サーバーからの応答：
   {
     "image_url": "http://localhost:8188/view?filename=ComfyUI_00001_.png&subfolder=&type=output"
   }
   

3. カスタムリクエスト： client.pyのpayloadを変更して、prompt、width、height、workflow_id、modelをカスタマイズできます。 例：

"params": json.dumps({
    "prompt": "a cat in space",
    "width": 768,
    "height": 768,
    "workflow_id": "basic_api_test",
    "model": "v1-5-pruned-emaonly.ckpt"
})

📚 ドキュメント

プロジェクト構成

• server.py：WebSocketトランスポートとライフサイクルサポートを備えたMCPサーバー。
• comfyui_client.py：ComfyUIのAPIとインターフェースを持ち、ワークフローのキューイングを処理します。
• client.py：MCPリクエストを送信するためのテストクライアント。
• workflows/：API形式のワークフローJSONファイルを格納するディレクトリ。

注意事項

⚠️ 重要提示

• 選択したモデル（例：v1-5-pruned-emaonly.ckpt）が<ComfyUI_dir>/models/checkpoints/に存在することを確認してください。
• MCP SDKにはネイティブのWebSocketトランスポートがないため、この実装ではカスタム実装を使用しています。
• カスタムワークフローの場合、必要に応じてcomfyui_client.pyのDEFAULT_MAPPINGノードIDを調整してください。

貢献

PRや問題の報告を歓迎します。特に、柔軟性の向上（例：動的ノードマッピング、進捗ストリーミング）に関する貢献を歓迎します。

📄 ライセンス

Apacheライセンス