ComfyUI MCP Server

An MCP server for interacting with ComfyUI instances running on your local network. This server provides tools for generating images and checking generation status through ComfyUI's API.

Installation

1. Clone this repository
2. Install dependencies:

npm install

3. Build the server:

npm run build

Configuration

The server requires the following environment variables:

• COMFYUI_SERVER_URL (optional): The URL of your ComfyUI instance. Defaults to http://127.0.0.1:8188

MCP Tools

generate_image

Generates an image using a ComfyUI workflow.

Parameters:

• workflow (required): A ComfyUI workflow JSON object
• wait (optional): Whether to wait for the image generation to complete. Defaults to true

Example:

const result = await mcp.useTool('comfyui-server', 'generate_image', {
  workflow: {
    "3": {
      "inputs": {
        "seed": 5,
        "steps": 20,
        "cfg": 8,
        "sampler_name": "euler",
        "scheduler": "normal",
        "denoise": 1,
        "model": ["4", 0],
        "positive": ["6", 0],
        "negative": ["7", 0],
        "latent_image": ["5", 0]
      },
      "class_type": "KSampler"
    },
    // ... rest of your workflow
  }
});

Returns:

{
  "promptId": "abc123",
  "imagePath": "temp/ComfyUI_00042.png"
}

check_status

Check the status of a prompt.

Parameters:

• promptId (required): The prompt ID to check

Example:

const status = await mcp.useTool('comfyui-server', 'check_status', {
  promptId: "abc123"
});

Returns:

{
  "status": {
    "completed": true,
    "executing": false
  },
  "hasImages": true
}

Development

To run the server in development mode with automatic reloading:

npm run dev

Notes

• Generated images are saved in a temp directory in the current working directory
• The server will automatically clean up old images on startup
• Requests will timeout after 5 minutes if the image generation doesn't complete