ComfyUI workflow execution skill for agents with packaged workflows and CLI tooling
Project description
ComfyUI Agent Skill
This repository is an Agent Skill folder (Claude Code / Claude.ai / Agent Skills). The only required file is SKILL.md.
- 中文文档: README.zh-CN.md
Status
- Requires a local or trusted self-hosted ComfyUI server (this repo is not a hosted service).
- Not a hosted generation service; this package does not provide a ComfyUI backend.
- This package does not install ComfyUI itself.
- Stable interface: registered workflows only + CLI with structured JSON output.
- Recommended trust model: do not point this at an untrusted public ComfyUI endpoint.
- PyPI package:
comfyui-agent-skill-mie(includescomfyui-skillalias).
Registered Workflows
Stable (reviewed configs in assets/workflows/*.config.json):
z_image_turbo(text-to-image)klein_edit(image edit)qwen3_tts(text-to-speech)ltx_23_t2v_distill(text-to-video)ltx_23_i2v_distilled(image-to-video)ace_step_15_music(music/audio)qwen_image_2512_4step(text-to-image)
Source of truth: the runtime registry is derived from assets/workflows/*.config.json (and the corresponding assets/workflows/*.json workflow files). If this list drifts, trust the configs and python -m comfyui generate --help output.
For Skill Users (Generate / Edit / Video / Audio)
Use this when you want to run registered ComfyUI workflows via the CLI in this repo.
- Primary entry: SKILL.md
- Workflow selection and sizing: references/workflows.md
- Full CLI contract (output paths, async submit/poll, JSON schemas, error codes): references/cli.md
- Prompt enhancement playbooks: references/prompt_enhancement/
Quick Start
Install (Recommended: pipx)
pipx install comfyui-agent-skill-mie
comfyui-agent-skill-mie check
comfyui-agent-skill-mie generate -p "a cute cat sitting on a windowsill at golden hour"
comfyui-skill check
comfyui-skill generate -p "a cute cat sitting on a windowsill at golden hour"
Alternative: uv tool install
uv tool install comfyui-agent-skill-mie
comfyui-agent-skill-mie check
comfyui-agent-skill-mie generate -p "a cute cat sitting on a windowsill at golden hour"
comfyui-skill check
comfyui-skill generate -p "a cute cat sitting on a windowsill at golden hour"
Source mode (for development / maintainers)
uv sync
uv run --no-sync python -m comfyui check
uv run --no-sync python -m comfyui generate -p "a cute cat sitting on a windowsill at golden hour"
Optional short command (after uv sync installs the project):
uv run --no-sync comfyui-skill check
uv run --no-sync comfyui-skill generate -p "a cute cat sitting on a windowsill at golden hour"
From a local wheel (for testing before PyPI publish):
pipx install dist/comfyui_agent_skill_mie-*.whl
Or install from GitHub:
pipx install "git+https://github.com/MieMieeeee/comfyui-agent-skill.git"
In tool-install mode, workflows/references are read from the installed package, while writable data goes to a per-user directory:
- Windows:
%APPDATA%\\comfyui-skill - macOS:
~/Library/Application Support/comfyui-skill - Linux:
$XDG_DATA_HOME/comfyui-skillor~/.local/share/comfyui-skill
Short alias also available: comfyui-skill
End-to-End Example (User input → decision → workflow → result)
This project is designed for agent-first workflow selection:
- The Agent makes the primary workflow decision using SKILL.md, workflow capability metadata, and references/workflows.md.
- The CLI only provides a low-risk fallback when no explicit
--workflowis chosen.
1) User input (natural language)
"帮我做一张海报,标题写「夏日促销」,风格现代简洁,主色调蓝白。"
2) Decision (what gets chosen and why)
- Task type: text-to-image
- Strong cue: poster / embedded text requirement ("海报", "标题写…")
- Prefer a stronger match over the general fallback T2I workflow
- Selected workflow:
qwen_image_2512_4step - Size choice:
704x1280(HD portrait preset for posters)
3) CLI command (agent explicitly chooses the workflow)
In this example, the agent explicitly chooses qwen_image_2512_4step; the CLI fallback selector is only a convenience when no explicit workflow is passed.
comfyui-skill generate \
--workflow qwen_image_2512_4step \
--width 704 --height 1280 \
-p "Modern minimalist marketing poster, blue and white palette, bold Chinese title text '夏日促销', clean layout, high contrast, product-focused composition"
4) Example JSON result (stdout)
{
"success": true,
"workflow_id": "qwen_image_2512_4step",
"status": "completed",
"outputs": [
{
"path": "C:\\\\Users\\\\<you>\\\\AppData\\\\Roaming\\\\comfyui-skill\\\\results\\\\20260504\\\\120301_<job_id>\\\\output.png",
"filename": "output.png",
"size_bytes": 1234567
}
],
"error": null,
"job_id": "<prompt_id>",
"metadata": {
"seed": 123456789,
"prompt_id": "<prompt_id>",
"prompt": "Modern minimalist marketing poster ...",
"width": 704,
"height": 1280
}
}
Adding Your Own Workflow (User Extension Example)
If you want to add your own ComfyUI workflow and make it available as a registered workflow:
1) Create a local workflow registry directory
Choose a directory for your local workflow registrations:
D:\comfyui-skill-custom\
assets\
workflows\
2) Import an exported ComfyUI workflow JSON
Export a workflow from ComfyUI (API format JSON), then run:
$env:COMFYUI_SKILL_ROOT="D:\comfyui-skill-custom"
python -m comfyui import-workflow .\my_workflow.json --id my_custom_workflow
This creates:
assets/workflows/my_custom_workflow.json
assets/workflows/my_custom_workflow.config.template.json
3) Review and activate the config
- Open
assets/workflows/my_custom_workflow.config.template.json - Fill in
capability,description,node_mapping,output_kind, and (optionally) selection metadata:intent_categories,input_modes,priority,keywords_any,selection_guidance
- Rename the reviewed file to:
assets/workflows/my_custom_workflow.config.json
Only *.config.json files are treated as registered workflows.
4) Run using your custom registry
Point runtime resources at your custom registry directory:
$env:COMFYUI_SKILL_RESOURCE_ROOT="D:\comfyui-skill-custom"
comfyui-skill generate --workflow my_custom_workflow -p "test prompt"
If you omit --workflow, the CLI may apply low-risk fallback selection (for example, poster-like keywords) but it will not attempt to fully “understand” your workflow. Agent-first selection remains the intended model.
Upgrade
If you installed via pipx:
pipx upgrade comfyui-agent-skill-mie
If you installed via uv tool:
uv tool upgrade comfyui-agent-skill-mie
Troubleshooting
- Run an environment doctor check (server + workflow preflight):
comfyui-skill doctor(recommended)comfyui-agent-skill-mie doctoruv run --no-sync python -m comfyui doctor(source mode)
- If the agent/skill runs inside WSL/container/sandbox while ComfyUI runs on the host OS,
127.0.0.1may point to the runtime itself instead of the host. Try--server http://localhost:8188or the host machine IP (and optionally persist it viasave-server). SERVER_UNAVAILABLE: ComfyUI is not reachable at the target URL. Start ComfyUI or re-run with--server http://<ip>:8188.PREFLIGHT_MISSING_NODES: install/enable required custom nodes on the ComfyUI server.PREFLIGHT_MISSING_MODELS: download required model files on the ComfyUI server.NO_OUTPUT: workflow ran but no media could be retrieved; check the workflow output node and server logs/UI.- For
PREFLIGHT_MISSING_NODES,PREFLIGHT_MISSING_MODELS, orNO_OUTPUT, consult the dependency reference: references/workflow_nodes.md.
For Maintainers (Add / Review Workflows)
Maintenance docs are intentionally kept out of SKILL.md to keep the skill instructions user-focused.
- Maintainer entry: MAINTAINER.md
- Detailed workflow registration guide: references/extension.md
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file comfyui_agent_skill_mie-0.1.6.tar.gz.
File metadata
- Download URL: comfyui_agent_skill_mie-0.1.6.tar.gz
- Upload date:
- Size: 14.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f5885159dda3e84110392caebf0b1bceafc7646201f9bd236c8d5d5f8731f592
|
|
| MD5 |
87366b5f5915aca3147dc1998ec642f7
|
|
| BLAKE2b-256 |
304c8c03739398d49f1509d496cf4c092caf7a940701862ccbae902d75fdb235
|
File details
Details for the file comfyui_agent_skill_mie-0.1.6-py3-none-any.whl.
File metadata
- Download URL: comfyui_agent_skill_mie-0.1.6-py3-none-any.whl
- Upload date:
- Size: 14.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5fffc835dbc66d307e5ec197fc1d9ace5bc2464e9f393b65903296097e212bb5
|
|
| MD5 |
6f59b7d60d220b8cc1c8cb628a706d07
|
|
| BLAKE2b-256 |
e3f43ccd84c5884dd51baa9b33d3148fd4fd119a10c6c62f73189bac23caa226
|