ComfyUI Skills for OpenClaw

This project is a ComfyUI skill integration layer for OpenClaw and other LLM agents. It turns the workflows you build and export from ComfyUI (API format) into callable skills that agents can trigger with natural language.

It converts natural language requests into structured skill arguments, maps them to ComfyUI workflow inputs, submits jobs to ComfyUI, waits for completion, then pulls generated images back to local disk.

What This Skill Can Do

• Turn your existing ComfyUI workflows into skills that OpenClaw or other agents can call directly
• Let OpenClaw or another agent call workflows deployed across different ComfyUI servers instead of being tied to a single machine
• Reuse the parameters you already exposed, so the agent can understand what each workflow expects
• Upload a workflow once, manage it from the UI, and use it again without rebuilding the whole setup
• Send jobs to ComfyUI, wait for completion, and pull the generated images back to local storage

---

Installation

ComfyUI Skills for OpenClaw

Manual install:

cd ~/.openclaw/workspace/skills
git clone https://github.com/HuangYuChuh/ComfyUI_Skills_OpenClaw.git comfyui-skill-openclaw
cd comfyui-skill-openclaw
pip install -r requirements.txt
cp config.example.json config.json

Let OpenClaw install it for you:

Send this prompt to OpenClaw:

Please install this ComfyUI skill into my OpenClaw workspace.

Target path:
~/.openclaw/workspace/skills/comfyui-skill-openclaw/

Requirements:
1. Run `cd ~/.openclaw/workspace/skills` first.
2. Clone this repository into `comfyui-skill-openclaw`.
3. Keep SKILL.md at the project root.
4. Install Python dependencies from requirements.txt.
5. Run `cp config.example.json config.json`.
6. Set the default ComfyUI server URL to http://127.0.0.1:8188 unless I specify another one.
7. Make sure OpenClaw can discover and call this skill after installation.

How To Configure ComfyUI Workflows

Before you start, make sure your ComfyUI server is already running. The default local address is http://127.0.0.1:8188.

I. Configure Through The UI (Recommended)

• macOS/Linux: ./ui/run_ui.sh, or double-click ui/run_ui.command
• Windows: ui\run_ui.bat
• Open: http://localhost:18189
• Upload a workflow JSON exported from ComfyUI in Save (API Format)
• Add your first ComfyUI server in the UI
• Select which parameters should be exposed to OpenClaw and save the mapping

II. Configure Through Files

1) Edit config.json

Configure your server first. Minimal example:

{
  "servers": [
    {
      "id": "local",                  // Server ID, also used as the directory name and workflow prefix
      "name": "Local",                // Display name
      "url": "http://127.0.0.1:8188", // ComfyUI server URL
      "enabled": true,                // Whether this server is enabled
      "output_dir": "./outputs"       // Image output directory
    }
  ],
  "default_server": "local"           // Default server ID
}

2) Place Workflow Files

Each workflow uses its own directory, for example:

data/local/Default/
  workflow.json  # ComfyUI API-format workflow export
  schema.json    # Parameter mapping exposed to OpenClaw/Agent

3) Write schema.json

schema.json should include at least:

• description
• enabled
• parameters

Minimal example:

{
  "description": "Default test workflow", // Human-readable description for OpenClaw/Agent
  "enabled": true,                        // Whether this workflow is enabled
  "parameters": {
    "prompt": {                           // Parameter name exposed to OpenClaw/Agent
      "node_id": 10,                      // Node ID in workflow.json
      "field": "prompt",                  // Input field name under that node
      "required": true,                   // Whether this field is required
      "type": "string",                   // Parameter type
      "description": "Prompt text"        // Parameter description
    },
    "seed": {
      "node_id": 10,
      "field": "seed",
      "required": false,
      "type": "int",
      "description": "Random seed"
    }
  }
}

Notes:

• The workflow ID comes directly from the directory name. For example, data/local/Default/ means the workflow ID is Default
• Each entry in parameters defines one input exposed to OpenClaw/Agent
• node_id and field must match the actual node and input field in workflow.json

If you want a full example, refer to:

• data/local/Default/workflow.json
• data/local/Default/schema.json

4) Verify The Configuration

List installed workflows:

python scripts/registry.py list

Run a test generation:

python scripts/comfyui_client.py \
  --workflow <server_id>/<workflow_id> \
  --args '{"prompt":"test"}'

Example:

python scripts/comfyui_client.py \
  --workflow local/Default \
  --args '{"prompt":"A premium product photo"}'

If it succeeds, the output will look like:

{
  "status": "success",
  "prompt_id": "...",
  "images": ["./outputs/<prompt_id>_...png"]
}

III. Let OpenClaw/Agent Configure It For You

• Let OpenClaw or another agent edit config.json
• Let the agent write workflow.json and schema.json into the target workflow directory
• After writing the files, let the agent run one verification step

Workflow Requirements (Important)

API-format workflows + a Save Image output node are the baseline requirements for stable use. To avoid failed or empty runs:

1. The workflow must be exported in ComfyUI API format

   • In ComfyUI, click Save (API Format)
   • Place the exported JSON at data/<server_id>/<workflow_id>/workflow.json

2. The workflow must end with a Save Image node

   • The current client downloads results from ComfyUI output images
   • Without a Save Image node (or equivalent image output), the workflow may finish but return no downloadable image

---

Multi-Server Management

You can configure multiple ComfyUI servers, so OpenClaw or another agent can dispatch jobs across different hardware targets such as a local GPU or a cloud instance.

Core Concepts

• Dual-Layer Toggles: Both servers and individual workflows can be enabled or disabled. A workflow is only visible to the AI agent if both the server and the workflow itself are enabled.
• Namespacing: Workflows are identified with a composite ID: <server_id>/<workflow_id> (e.g., local/sdxl-base vs. cloud-a100/sdxl-base).

CLI Configuration

On headless machines, you can use the built-in CLI tool scripts/server_manager.py:

python scripts/server_manager.py list
python scripts/server_manager.py add --id cloud --name "Cloud Node" --url http://10.0.0.1:8188
python scripts/server_manager.py disable cloud

You can still manage all server settings through the Web UI.

Configuration Migration (Export / Import)

If you move this skill to another path or another machine, use the built-in bundle flow to transfer your current config and workflow mappings.

UI flow:

• Click Export Config on the main page to download openclaw-skill-export.json
• Before export, you can expand each server and uncheck workflows you do not want to include; all workflows are selected by default and servers are collapsed by default
• Open the UI on the target machine and click Import Config
• Select the exported JSON bundle
• Review the preview summary, then decide whether to also apply the source machine's default server, URL, and output directory

CLI flow:

python scripts/transfer_manager.py export --output ./openclaw-skill-export.json
python scripts/transfer_manager.py import --input ./openclaw-skill-export.json --dry-run
python scripts/transfer_manager.py import --input ./openclaw-skill-export.json

Optional flags:

• --apply-environment: also apply bundle default server, URL, and output directory during import
• --no-overwrite: skip existing workflows instead of overwriting them

Default import behavior:

• Existing workflows with the same ID are overwritten
• Existing servers are merged instead of replaced
• The target machine keeps its current url, output_dir, and default_server unless --apply-environment is used

---

Known Caveats

• If ComfyUI returns HTTP 400 on /prompt, the workflow payload or parameter value is usually invalid.
• size must match values accepted by the underlying node (e.g. 3:4,1728x2304).
• If config.json points to the wrong server URL, job queueing will fail.

---

Roadmap (next)

• Workflow version history and rollback
• Upgrade preview before applying a new workflow version
• Parameter migration support when upgrading a workflow
• Better schema validation before queueing
• Richer error reporting from ComfyUI node errors
• Optional batch generation / multi-seed helpers

---

Project Structure

ComfyUI_Skills_OpenClaw/
├── SKILL.md                    # Agent instruction spec (how to call registry/client)
├── README.md
├── README.zh.md
├── LICENSE
├── .gitignore
├── requirements.txt            # Python deps (FastAPI, requests, etc.)
├── config.example.json         # Example runtime config
├── config.json                 # Actual local runtime config (gitignored)
├── asset/
│   └── banner-ui-20250309.jpg
├── data/
│   ├── <server_id>/
│   │   └── <workflow_id>/
│   │       ├── workflow.json       # ComfyUI workflow API export
│   │       └── schema.json         # Exposed parameter mapping
├── scripts/
│   ├── server_manager.py       # CLI tool for managing servers
│   ├── registry.py             # List workflows + exposed parameters for agent
│   ├── comfyui_client.py       # Inject args, queue prompt, poll history, download images
│   └── shared/                 # Shared config & JSON utils (reused across scripts)
│       ├── config.py
│       ├── json_utils.py
│       └── runtime_config.py
├── ui/
│   ├── app.py                  # FastAPI app – routes only
│   ├── open_ui.py              # Agent-friendly UI launcher
│   ├── services.py             # Business logic (workflow CRUD)
│   ├── models.py               # Pydantic request/response models
│   ├── json_store.py           # Low-level JSON file read/write helpers
│   ├── settings.py             # App-level settings
│   ├── run_ui.sh               # Start UI (macOS/Linux)
│   ├── run_ui.command          # Double-click launcher (macOS)
│   ├── run_ui.bat              # Launcher (Windows)
│   └── static/                 # Modular ES6 frontend (HTML/CSS/JS)
└── outputs/
    └── .gitkeep

---

Project Keywords And Resources

Project Keywords

This repository is optimized around these search intents:

• OpenClaw
• ComfyUI
• ComfyUI Skills
• ComfyUI workflow automation
• OpenClaw ComfyUI integration
• AI image generation skill
• Xiao Long Xia (small crawfish / 小龙虾, project nickname)

Related files for project understanding and retrieval:

• README.md (English overview)
• README.zh.md (Chinese overview)
• SKILL.md (agent execution contract)
• docs/llms.txt and docs/llms-full.txt (LLM-oriented summaries)

---

Project Resources

• Project summary: docs/llms.txt
• Extended project context: docs/llms-full.txt
• Project discovery checklist: docs/PROJECT_DISCOVERY_CHECKLIST.md