ComfyUI MCP Server

Overview

• Flexible workflow selection (e.g., basic_api_test.json).

• Dynamic parameters: prompt, width, height, and model.

• Returns image URLs served by ComfyUI.

Prerequisites

• Python 3.10+

• ComfyUI: Installed and running locally (e.g., on localhost:8188).

• Dependencies: requests, websockets, mcp (install via pip).

Setup

1. Clone the Repository: git clone <your-repo-url> cd comfyui-mcp-server

2. Install Dependencies:pip install requests websockets mcp

3. Start ComfyUI:

• Install ComfyUI (see ComfyUI docs).

• Run it on port 8188:

1. Prepare Workflows:

• Place API-format workflow files (e.g., basic_api_test.json) in the workflows/ directory.

• Export workflows from ComfyUI s UI with Save (API Format) (enable dev mode in settings).

Usage

1. Run the MCP Server: python server.py

• Listens on ws://localhost:9000.

1. Test with the Client: python client.py

• Sends a sample request: "a dog wearing sunglasses" with 512x512 using sd_xl_base_1.0.safetensors.

• Output example:

1. Custom Requests:

• Modify client.py s payload to change prompt, width, height, workflow_id, or model.

• Example:

Project Structure

• server.py: MCP server with WebSocket transport and lifecycle support.

• comfyui_client.py: Interfaces with ComfyUI s API, handles workflow queuing.

• client.py: Test client for sending MCP requests.

• workflows/: Directory for API-format workflow JSON files.

Notes

• Ensure your chosen model (e.g., v1-5-pruned-emaonly.ckpt) exists in <ComfyUI_dir>/models/checkpoints/.

• The MCP SDK lacks native WebSocket transport; this uses a custom implementation.

• For custom workflows, adjust node IDs in comfyui_client.py s DEFAULT_MAPPING if needed.

Contributing

License

ComfyUI MCP Server

Overview

• Flexible workflow selection (e.g., basic_api_test.json).

• Dynamic parameters: prompt, width, height, and model.

• Returns image URLs served by ComfyUI.

Prerequisites

• Python 3.10+

• ComfyUI: Installed and running locally (e.g., on localhost:8188).

• Dependencies: requests, websockets, mcp (install via pip).

Setup

1. Clone the Repository: git clone <your-repo-url> cd comfyui-mcp-server

2. Install Dependencies:pip install requests websockets mcp

3. Start ComfyUI:

• Install ComfyUI (see ComfyUI docs).

• Run it on port 8188:

1. Prepare Workflows:

• Place API-format workflow files (e.g., basic_api_test.json) in the workflows/ directory.

• Export workflows from ComfyUI s UI with Save (API Format) (enable dev mode in settings).

Usage

1. Run the MCP Server: python server.py

• Listens on ws://localhost:9000.

1. Test with the Client: python client.py

• Sends a sample request: "a dog wearing sunglasses" with 512x512 using sd_xl_base_1.0.safetensors.

• Output example:

1. Custom Requests:

• Modify client.py s payload to change prompt, width, height, workflow_id, or model.

• Example:

Project Structure

• server.py: MCP server with WebSocket transport and lifecycle support.

• comfyui_client.py: Interfaces with ComfyUI s API, handles workflow queuing.

• client.py: Test client for sending MCP requests.

• workflows/: Directory for API-format workflow JSON files.

Notes

• Ensure your chosen model (e.g., v1-5-pruned-emaonly.ckpt) exists in <ComfyUI_dir>/models/checkpoints/.

• The MCP SDK lacks native WebSocket transport; this uses a custom implementation.

• For custom workflows, adjust node IDs in comfyui_client.py s DEFAULT_MAPPING if needed.

Contributing

License