MCP Comfy Ui Builder

🚀 mcp-comfy-ui-builder

ComfyUI Node Discovery — カーソル/Claude用の知識ベースとMCPツールです。server.json と mcpName を通じて MCP Registry に公開可能です。

🚀 クイックスタート

インストール

npm install mcp-comfy-ui-builder

またはソースからインストールする場合は、以下のコマンドを実行します。

git clone https://github.com/MIt9/mcp-comfy-ui-builder.git && cd mcp-comfy-ui-builder && npm install

ビルドと起動

1. ビルド (ビルド後にシードから知識を埋め込みます)

   npm run build
   npm run mcp
   

2. コードで知識を使用する

   import baseNodes from './knowledge/base-nodes.json' assert { type: 'json' };
   

✨ 主な機能

• 知識ベース：バンドルされたデータから knowledge/base-nodes.json と node-compatibility.json をシードします (62のシードノード; 同期後は100 - 600以上)。提案/構築に外部サービスは必要ありません。
• 同期：ComfyUI-Managerからのカスタムパック; sync-nodes CLIまたはMCP起動時に実行中のComfyUIからのノードを同期します。
• MCPサーバー (50以上のツール)：ノードの探索、動的ワークフロービルダー、9つのテンプレート (txt2img, txt2img_flux, img2img, …)、WebSocketリアルタイム実行、バッチ/チェーン、モデル管理、プラグインシステム。
• リアルタイム実行：WebSocketを介したサブ秒単位の進捗表示と自動ポーリングのフォールバック; バッチ実行時のネットワークトラフィックを約90%削減。

📦 インストールガイド

npm install mcp-comfy-ui-builder

またはソースからのインストール:

git clone https://github.com/MIt9/mcp-comfy-ui-builder.git && cd mcp-comfy-ui-builder && npm install

💻 使用例

基本的な使用法

# ビルド
npm run build
# MCPサーバーの起動
npm run mcp

高度な使用法

// コードで知識を使用する
import baseNodes from './knowledge/base-nodes.json' assert { type: 'json' };

📚 ドキュメント

単一のエントリポイント — タスク指向のナビゲーションです。

• doc/README.md — 開始方法、タスクベースのナビゲーション
• doc/INDEX.md — ドキュメントとリンクの完全なリスト
• doc/QUICK-REFERENCE.md — コマンド、例、トラブルシューティング
• doc/GETTING-STARTED.md — クイックスタート
• doc/MCP-SETUP.md — カーソル/ClaudeでMCPを接続する
• doc/DOCKER-SETUP.md — docker pull siniidrozd/mcp-comfy-ui-builder | MCP + ComfyUIのdocker-compose
• 知識ベース：knowledge/README.md, doc/knowledge-base-usage-guide.md
• ワークフロービルダー：doc/workflow-builder.md — テンプレート、パラメータ、保存/読み込み、ComfyUI形式
• 計画：ROADMAP.md, NEXT-STEPS.md, TODO.md — 現在のv2.3.x、次のフェーズ10 (QoL)
• 貢献：CONTRIBUTING.md
• MCPレジストリ：server.json とpackage.json内の mcpName; npm publish 後に公開するには MCP Registry quickstart を参照してください。

🔧 技術詳細

必要条件

• Node.js 18+

MCPサーバー (カーソル / Claude)

サーバーは9つのカテゴリにわたる50以上のツールを提供します。

コア機能

ノードの探索：

• list_node_types, get_node_info, check_compatibility, suggest_nodes
• discover_nodes_live, search_nodes, sync_nodes_to_knowledge

動的ワークフロービルダー：

• create_workflow, add_node, connect_nodes, validate_workflow
• JSON操作なしでプログラム的にワークフローを構築

テンプレートとマクロ：

• list_templates, build_workflow — 事前構築されたテンプレート (txt2img, img2img, インペイント, アップスケール, LoRA, ControlNet, バッチ)
• create_template, apply_template — パラメータ化されたテンプレート
• list_macros, insert_macro — 再利用可能なサブワークフロー

リアルタイム実行 📡

• execute_workflow_sync — WebSocket進捗ストリーミングで実行 (サブ秒単位の更新)
• execute_workflow_stream — 完全なイベント履歴収集 (WebSocketのみ)
• get_execution_progress — ノードレベルの粒度でのリアルタイム進捗
• execute_batch — ネットワークトラフィックを 90%削減 した並列実行
• execute_chain — データを渡しながらのシーケンシャルなワークフロー

リソースとモデル管理：

• get_system_resources — GPU/VRAM/RAM + 推奨事項 (最大解像度、モデルサイズ、バッチサイズ); ワークフローを構築する前に 最初に呼び出す ことでOOMを回避
• list_models, check_model_exists, get_workflow_models
• チェックポイント、lora、vae、controlnet、アップスケール、埋め込み、クリップをサポート

出力とキュー：

• list_outputs, download_output, download_all_outputs
• list_queue, interrupt_execution, clear_queue

プラグイン：

• list_plugins, reload_plugins — データのみのプラグインシステム

インストール (COMFYUI_PATHが必要)：

• install_custom_node, install_model — ComfyUI-Managerを介してノードとモデルをインストール

WebSocket機能

• <100msのレイテンシ で進捗更新 (1.5秒のポーリングと比較)
• ノードレベルの追跡：進行率とともに正確にどのノードが実行中かを確認
• 自動フォールバック：WebSocketが利用できない場合にポーリングに優雅にフォールバック
• 共有接続：バッチ/チェーン実行に単一のWebSocketを使用 (90%のトラフィック削減)

実行/モデル/出力ツールには COMFYUI_HOST 環境変数を設定します。

export COMFYUI_HOST="http://localhost:8188"

完全なツールリストは doc/MCP-SETUP.md を、リアルタイム機能は doc/WEBSOCKET-GUIDE.md を参照してください。

MCPの実行

プロジェクトのルートから、まずプロジェクトをビルドし、次にサーバーを起動します。

npm run build
npm run mcp

またはnpmを使用せずに：node dist/mcp-server.js。サーバーは stdio (stdin/stdout) を介して動作します。詳細は doc/MCP-SETUP.md を参照してください。

MCPの接続 (カーソル / Claude)

必要なもの：Node.js 18+、一度のビルド (npm run build)、dist/mcp-server.js の 絶対パス、設定変更後は再起動が必要です。サーバーが «spawn node ENOENT» で起動できない場合は、command で nodeの完全パス を使用してください (which node を実行し、そのパスを入力)。トラブルシューティングについては doc/MCP-SETUP.md を参照してください。

最小限の設定 (知識とワークフローツールのみ)：

{
  "mcpServers": {
    "comfy-ui-builder": {
      "command": "node",
      "args": ["/ABSOLUTE/PATH/TO/mcp-comfy-ui-builder/dist/mcp-server.js"]
    }
  }
}

Cursor/IDEが «spawn node ENOENT» と報告する場合は、command で完全パスを使用してください (例: "/opt/homebrew/bin/node")。

ComfyUI実行を含む設定 (execute_workflow, get_execution_status, list_outputs, など)：サーバーブロックに "env": { "COMFYUI_HOST": "http://127.0.0.1:8188" } を追加します。完全なチェックリスト、オプションの環境変数 (COMFYUI_PATH, COMFYUI_KNOWLEDGE_DIR)、およびトラブルシューティングについては doc/MCP-SETUP.md を参照してください。

GitHubへの公開

1. GitHub で新しいリポジトリを作成します。名前は mcp-comfy-ui-builder、可視性はPublic (またはPrivate) とします。README、.gitignore、またはライセンスで初期化しないでください (プロジェクトにすでにあります)。
2. リモートを追加してプッシュします。

   git remote add origin https://github.com/MIt9/mcp-comfy-ui-builder.git
   git branch -M main
   git push -u origin main
   

3. このリポジトリをフォークした場合は、上記のURLの MIt9 をあなたのGitHubユーザー名に置き換えてください。

Cursor：設定 → MCP; Claude Desktop：設定ファイル ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)。dist/mcp-server.js の絶対パスに置き換えてから、アプリを再起動します。完全なガイドは doc/MCP-SETUP.md を参照してください。

📄 ライセンス

MIT