Lalanikarim Comfy MCP Server

🚀 Comfy MCP Server

A server that uses the FastMCP framework to generate images based on prompts through a remote Comfy server.

🚀 Quick Start

This script sets up a server using the FastMCP framework to generate images based on prompt statements through a specified workflow. It interacts with a remote Comfy server to submit prompts and retrieve the generated images.

✨ Features

• Generate images based on specified prompts.
• Interact with a remote Comfy server to handle image generation tasks.

📦 Installation

Prerequisites

• Python 3.x installed.
• Required packages: mcp, json, urllib, time, os.
• An exported workflow file from Comfy UI. This code includes an example Flux-Dev-ComfyUI-Workflow.json, which is only used as a reference here. You need to export from your workflow and set the environment variables accordingly.

You can install the required packages using pip:

pip install "mcp[cli]"

Configuration

Set the following environment variables:

• COMFY_URL points to your Comfy server URL.
• COMFY_WORKFLOW_JSON_FILE points to the absolute path of the API export JSON file of your workflow.
• PROMPT_NODE_ID is set to the ID of the text prompt node you are using.
• OUTPUT_NODE_ID is set to the ID of the output node that contains the final image.

Example:

export COMFY_URL=http://your-comfy-server-url:port
export COMFY_WORKFLOW_JSON_FILE=/path/to/the/comfyui_workflow_export.json
export PROMPT_NODE_ID=6 # Use the correct node ID
export OUTPUT_NODE_ID=9 # Use the correct node ID

💻 Usage Examples

Basic Usage

Run the script directly:

python comfy-mcp-server.py

The server will start and listen for requests to generate images based on the provided prompts.

📚 Documentation

Functionality

generate_image(prompt: str, ctx: Context) -> Image | str

This function generates an image based on the specified prompt. It follows these steps:

1. Check if all environment variables are set.
2. Load the prompt template from the JSON file.
3. Submit the prompt to the Comfy server.
4. Poll the server for the status of prompt processing.
5. Retrieve and return the generated image after the prompt is completed.

Dependencies

• mcp: Used to set up the FastMCP server.
• json: Used to handle JSON data.
• urllib: Used to make HTTP requests.
• time: Used to add a delay when polling.
• os: Used to access environment variables.

📄 License

This project is released under the MIT License. See the LICENSE file for details.