Comfyui

🚀 ComfyUI MCP服務器

ComfyUI MCP服務器是一個輕量級的基於Python的MCP（模型上下文協議）服務器，它與本地ComfyUI實例接口，可讓AI代理通過請求來生成圖像，為圖像生成工作提供了便捷的途徑。

🚀 快速開始

此項目能讓AI代理藉助MCP協議，通過WebSocket向ComfyUI發送圖像生成請求。它具備靈活的工作流程選擇，支持動態參數設置，還能返回由ComfyUI提供的圖像URL。

✨ 主要特性

• 支持靈活的工作流程選擇，例如可選用basic_api_test.json工作流程。
• 能夠設置動態參數，包括prompt（提示詞）、width（寬度）、height（高度）和model（模型）。
• 可返回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"
}

高級用法

自定義請求

可修改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：MCP服務器，帶有WebSocket傳輸和生命週期支持。
• 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許可證。