Documentation Index
Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
Use this file to discover all available pages before exploring further.
Closed Beta — invite only. Comfy Cloud MCP is currently in a closed beta with per-user feature flag gating. Features, tools, and behavior may change as the project evolves. If you don’t have access yet, sign up for the waitlist.
Comfy Cloud MCP connects AI assistants — including Claude Desktop, Claude Code, Cursor, and Amp — to Comfy Cloud via the Model Context Protocol (MCP). It lets AI agents generate images, video, audio, and 3D content, search models and nodes, and run full ComfyUI workflows on cloud GPUs, with no local GPU required.
Quick Start
1. Get Your API Key
Visit https://platform.comfy.org/login and Log In
Click `+ New` in API Keys to Create an API Key
Click + New in API Keys to create an API Key
Enter API Key Name

- (Required) Enter the API Key name,
- Click
Generate to create
Save the Obtained API Key

Since the API Key is only visible upon first creation, please save it immediately after creation. It cannot be viewed later, so please keep it safe.
Please note that you should not share your API Key with others. Once it leaked, you can delete it and create a new one.
2. Install & Connect
The easiest way to get started is with the one-click installer. It detects your MCP client (Claude Code, Cursor, Amp), asks for your Comfy API key, and configures the remote MCP server — no Node.js or other dependencies required.
Requirements:
- Active Comfy Cloud subscription (required to submit workflows)
- Comfy API key (starts with
comfyui-)
- Your email enabled for the closed beta (see note above)
macOS / Linux
Windows (PowerShell)
curl -fsSL https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.sh | bash
irm https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.ps1 | iex
Manual Setup (Alternative)
If you prefer to configure manually, Comfy Cloud MCP is hosted at https://cloud.comfy.org/mcp. Point your MCP client at the server URL with your API key:
Claude Code
Claude Desktop
Cursor
claude mcp add comfyui-cloud \
--transport http \
https://cloud.comfy.org/mcp \
-H "X-API-Key: your-api-key-here"
Add the following to your Claude Desktop config file:| OS | Config path |
|---|
| macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
| Windows | %APPDATA%\Claude\claude_desktop_config.json |
| Linux | ~/.config/Claude/claude_desktop_config.json |
{
"mcpServers": {
"comfyui-cloud": {
"url": "https://cloud.comfy.org/mcp",
"headers": {
"X-API-Key": "your-api-key-here"
}
}
}
}
Add the following to your Cursor MCP config (.cursor/mcp.json in your project or global config):{
"mcpServers": {
"comfyui-cloud": {
"url": "https://cloud.comfy.org/mcp",
"headers": {
"X-API-Key": "your-api-key-here"
}
}
}
}
See Cursor’s MCP documentation for more details.
After adding the server, restart your MCP client to pick up the new configuration.
Usage
Just ask. The agent picks the right tools on its own — “generate a cat astronaut in space”, “find SDXL checkpoints”, “upscale this”.
Slash Commands (Claude Code Only)
These optional slash commands provide shortcuts with extra context for common tasks:
| Type | What you get |
|---|
/comfy-generate-image | Image from a prompt |
/comfy-generate-video | Video from text or an image |
/comfy-generate-3d | 3D mesh (GLB/FBX/OBJ) |
/comfy-generate-audio | Speech or sound effects |
/comfy-upscale-image | Upscale an image |
/comfy-remove-background | Remove background |
/comfy-search-models | Search the model catalog |
/comfy-search-nodes | Search nodes with wiring hints |
/comfy-search-templates | Find pre-built workflows |
/technique-combine-people | Composite multiple people into one shot |
/comfy-help | What can I do? |
Generate via Workflow
| Tool | Description |
|---|
submit_workflow | Submit a ComfyUI API-format workflow for execution on Comfy Cloud |
get_job_status | Poll execution status of a submitted workflow |
get_output | Retrieve output images, videos, or audio from a completed workflow |
cancel_job | Cancel a pending or running job |
get_queue | Check how many jobs are running and pending |
Generate via Partner APIs (No Cloud GPU Cost)
| Tool | Description |
|---|
partner_generate | Generate using partner APIs — Flux Pro, Nano Banana, Grok, GPT-image-1, Ideogram, Seedream (no Cloud GPU cost) |
Discovery
| Tool | Description |
|---|
search_templates | Search pre-built workflow templates from comfy.org by text, tag, media type, or model |
search_models | Search model catalog by text, type, base model, or source |
search_nodes | Search available nodes by text, category, or input/output types |
cql | Run Comfy Query Language queries for advanced discovery |
| Tool | Description |
|---|
upload_file | Upload an input image or file for use in workflows (e.g. LoadImage) |
use_previous_output | Chain workflows by reusing the output of one as input to another |
Saved Workflows
| Tool | Description |
|---|
list_saved_workflows | Browse your saved workflows from Comfy Cloud |
get_saved_workflow | Inspect a saved workflow’s nodes, inputs, and configuration |
save_workflow | Save the current workflow configuration |
run_saved_workflow | Execute a previously saved workflow |
Feedback (Beta)
| Tool | Description |
|---|
submit_feedback | Submit feedback with a rating and comment |
report_session_summary | Report a consent-gated session summary (no prompts, file paths, or PII) |
The server checks for a matching pre-built template before building a workflow from scratch, leading to better results and faster generation.
Feedback
This is a closed beta — please tell us what’s working.
- In-agent: ask the agent to call
submit_feedback (rating + comment) or report_session_summary (consent-gated session summary; no prompts/file paths/PII).
- Survey: links.comfy.org/cloudmcpbeta
- Issues: file in this repo
Tool errors include a once-per-session pointer back to these channels so you don’t have to remember them.
How It Works
┌──────────────┐ HTTPS/MCP ┌─────────────────────────────────────────────┐
│ AI Agent │◄───────────────►│ Comfy Cloud │
│ (Claude, │ X-API-Key │ cloud.comfy.org/mcp → Workflow Execution │
│ Cursor, │ │ on Cloud GPUs │
│ Amp) │ │ │
└──────────────┘ └─────────────────────────────────────────────┘
Your AI agent connects directly to the hosted MCP server at cloud.comfy.org/mcp. The server translates MCP tool calls into workflow executions on Comfy Cloud GPUs — no local server or GPU required.
The AI agent uses the discovery tools to find templates and nodes, then constructs the ComfyUI API-format workflow JSON, submits it, and returns the results — just describe what you want in natural language.
Example Prompts
After installing, try these prompts in your AI assistant:
Generate an image of a cat astronaut floating in space, cartoon style
Find me workflow templates for text-to-video generation
Search for SDXL checkpoint models and tell me which ones are available
Generate a fantasy landscape with mountains and a glowing river at sunset
What nodes are available for image upscaling?
The agent will search for a matching template, build the ComfyUI workflow, submit it to Comfy Cloud, and return the generated image directly in the conversation.
Output Handling
- Images are displayed inline in the conversation (Claude Code) or in the artifact side panel (Claude Desktop)
- Video and audio outputs are returned as downloadable links
- Animated images (GIF, WebP) are saved but not previewed inline to preserve animation
- Inline image previews are resized to 1024px for efficient display; full-resolution outputs are always available via the
get_output tool
Known Limitations
This is an early release. The following limitations are known and being actively worked on.
Workflows
- Cannot run saved workflows by ID. You can browse and inspect saved workflows (
list_saved_workflows, get_saved_workflow), but not always execute them directly. Saved workflows use the ComfyUI graph format, which requires conversion to API format. The AI agent must reconstruct the workflow from scratch.
- Generated assets have no workflow metadata. Images created via the MCP server don’t include workflow JSON in their metadata, so they won’t show the workflow when opened in ComfyUI.
- Workflow accuracy depends on the AI. The agent constructs ComfyUI workflows from natural language. Complex multi-node workflows or unusual node configurations may require iteration.
File Handling
- Upload size limits may apply depending on your MCP client.
- Image previews are resized. Inline previews are limited to 1024px (JPEG). Full-resolution files are saved to disk.
Authentication
- API key only. Authentication requires a Comfy Cloud API key passed via the
X-API-Key header. Browser-based OAuth is not yet available.
Client-Specific
- Claude Desktop — Generated images appear in the artifact side panel via HTML, not as native image artifacts.
- Claude Desktop chat mode — Requires OAuth, which is coming soon. Use Code mode in the meantime — it picks up the Claude Code config automatically.
Troubleshooting
MCP server not showing up
Restart your MCP client (close and reopen Claude Code, Claude Desktop, Cursor, or Amp). MCP servers are loaded at startup. Double-check that the server URL is exactly https://cloud.comfy.org/mcp in your config.
API key errors
Verify your API key is valid at platform.comfy.org/profile/api-keys. Make sure the key is passed in the X-API-Key header (not as a Bearer token). Generate a new key if needed and update your client config.
Connection errors
If the MCP client can’t reach the server, check that:
- You have an active internet connection
- Your firewall or proxy isn’t blocking
cloud.comfy.org
- You have an active Comfy Cloud subscription