Skip to content

Commit 3dd3ce8

Browse files
authored
Expand Comfy Cloud MCP user docs and sync i18n (#1204)
Document MCP tools, outputs, workflow sharing, and known limitations so users know what agents can do without server-side setup details.
1 parent 3664a9a commit 3dd3ce8

8 files changed

Lines changed: 669 additions & 191 deletions

File tree

agent-tools/cloud.mdx

Lines changed: 126 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,77 @@ import CloudFeature from '/snippets/cloud-feature.mdx'
1515

1616
## Overview
1717

18-
The **Comfy Cloud MCP server** connects AI agents to [Comfy Cloud](https://cloud.comfy.org) over the [Model Context Protocol](https://modelcontextprotocol.io). Once connected, you can generate images, video, audio, and 3D, search models, nodes, and templates, and run ComfyUI workflows — all from a chat with your agent.
18+
The **Comfy Cloud MCP server** connects AI agents to [Comfy Cloud](https://cloud.comfy.org) over the [Model Context Protocol](https://modelcontextprotocol.io). Once connected, you can generate images, video, audio, and 3D, search models, nodes, and templates, and run ComfyUI workflows from a chat with your agent.
1919

20-
Support is currently scoped to **Claude Code** and **Claude Desktop**, which sign in with **OAuth** — a one-time browser sign-in. Support for more clients is coming.
20+
The server runs remotely at `cloud.comfy.org/mcp`. Workflows execute on Comfy Cloud GPUs, so you do not need a local GPU. Your agent talks to the server over HTTPS; the server translates tool calls into authenticated requests to Comfy Cloud on your behalf.
21+
22+
Support is currently scoped to **Claude Code** and **Claude Desktop**, which sign in with **OAuth** (a one-time browser sign-in). Support for more clients is coming.
23+
24+
## What your agent can do
25+
26+
You do not call MCP tools yourself. Your agent picks the right tool based on what you ask for. Slash commands and prompts (below) are shortcuts that steer the agent toward common tasks, but plain language works too ("generate an image of a cat astronaut", "upscale this photo", "find a Wan 2.2 video template").
27+
28+
Typical flow:
29+
30+
1. **Discover** what is available (`search_templates`, `search_models`, `search_nodes`, or `cql` for graph-style questions).
31+
2. **Run** a generation or workflow (`submit_workflow`, with `upload_file` when an input image is needed).
32+
3. **Retrieve** outputs (`get_output` returns a download command your agent runs in your shell).
33+
34+
The server prefers matching [pre-built templates](https://comfy.org/workflows) before building a workflow from scratch, which tends to produce better results faster.
35+
36+
## MCP tools
37+
38+
These are the tools your agent has access to once connected. Names match what appears in MCP client logs and debugging.
39+
40+
### Discovery
41+
42+
| Tool | Description |
43+
| --- | --- |
44+
| `search_templates` | Search pre-built workflow templates from [comfy.org](https://comfy.org/workflows) by text, tag, media type, or model |
45+
| `search_models` | Search the model catalog by text, type, base model, or source |
46+
| `search_nodes` | Search available nodes by text, category, or input/output types. Also surfaces **subgraph blueprints** (pre-wired node groups like Text to Image or Remove Background) |
47+
| `cql` | Run a [CQL](https://github.com/Comfy-Org/cql) graph query for structural questions (for example, which nodes produce images, or paths between node types). Use `search_nodes` when you need full input specs for a specific node |
48+
49+
### Execution
50+
51+
| Tool | Description |
52+
| --- | --- |
53+
| `submit_workflow` | Submit a ComfyUI API-format workflow for execution on Comfy Cloud |
54+
| `upload_file` | Upload an input image or file for use in workflows (for example, with LoadImage) |
55+
| `get_job_status` | Poll execution status of a submitted workflow |
56+
| `get_output` | Retrieve output images, videos, or audio from a completed workflow |
57+
| `use_previous_output` | Chain workflows by reusing output from one run as input to another |
58+
| `cancel_job` | Cancel a pending or running job |
59+
| `get_queue` | Check how many jobs are running and pending |
60+
61+
### Saved workflows
62+
63+
| Tool | Description |
64+
| --- | --- |
65+
| `list_saved_workflows` | Browse your saved workflows from Comfy Cloud |
66+
| `get_saved_workflow` | Inspect a saved workflow's nodes, inputs, and configuration |
67+
| `save_workflow` | Save a workflow to your Comfy Cloud account |
68+
69+
<Note>
70+
You can browse and inspect saved workflows, but the agent cannot run them by ID directly today. Saved workflows use the ComfyUI graph format and must be converted to API format before execution. See [Known limitations](#known-limitations).
71+
</Note>
72+
73+
### Sharing workflows
74+
75+
| Tool | Description |
76+
| --- | --- |
77+
| `share_workflow` | Publish a saved workflow and return a `?share=<id>` URL anyone can open |
78+
| `import_shared_workflow` | Resolve a share URL or bare share ID into workflow JSON, optionally saving it to your account |
79+
80+
**Hub URL share IDs:** the trailing hyphen-delimited hex token in a `comfy.org/workflows/<slug>-<hex>` hub URL is the share ID. For example, `comfy.org/workflows/topaz-starlight-upscale-1c77e82713b7` has share ID `1c77e82713b7`. Pass that token to `import_shared_workflow` as `share_id`. The `share_url` parameter only accepts `?share=<id>` query URLs like `https://cloud.comfy.org/?share=...`, not hub page URLs.
2181

2282
## Install
2383

2484
Pick your client:
2585

2686
<CardGroup cols={2}>
2787
<Card title="Claude Code" icon="terminal" href="#claude-code">
28-
Install the plugin — connection and commands in one step.
88+
Install the plugin. Connection and commands in one step.
2989
</Card>
3090
<Card title="Claude Desktop" icon="desktop" href="#claude-desktop">
3191
Add a custom connector in the app, then sign in.
@@ -60,14 +120,14 @@ The plugin adds these slash commands:
60120
| --- | --- |
61121
| `/comfy-cloud:generate-image` | Generate, edit, or modify an image |
62122
| `/comfy-cloud:generate-video` | Generate, edit, or extend a video |
63-
| `/comfy-cloud:generate-audio` | Generate audio |
64-
| `/comfy-cloud:generate-3d` | Generate a 3D model |
123+
| `/comfy-cloud:generate-audio` | Generate audio, music, or sound effects |
124+
| `/comfy-cloud:generate-3d` | Generate a 3D model from text or an image |
65125
| `/comfy-cloud:remove-background` | Remove the background from an image |
66-
| `/comfy-cloud:upscale-image` | Upscale an image |
67-
| `/comfy-cloud:search-models` | Search available models |
68-
| `/comfy-cloud:search-nodes` | Search for nodes |
69-
| `/comfy-cloud:search-templates` | Find pre-built workflows |
70-
| `/comfy-cloud:help` | See what you can do |
126+
| `/comfy-cloud:upscale-image` | Upscale an image to higher resolution |
127+
| `/comfy-cloud:search-templates` | Find pre-built workflow templates on [comfy.org](https://comfy.org) |
128+
| `/comfy-cloud:search-models` | Search for available models |
129+
| `/comfy-cloud:search-nodes` | Search for nodes and get wiring suggestions |
130+
| `/comfy-cloud:help` | See what you can do with ComfyUI Cloud |
71131

72132
<Accordion title="Prefer just the connection, without the plugin?">
73133
Add the server directly:
@@ -78,7 +138,7 @@ The plugin adds these slash commands:
78138

79139
Then run `/mcp`, select **comfy-cloud****Authenticate**. Add `-s user` to make it available in all your projects.
80140

81-
This path still gives you slash commands, but in raw MCP form — `/mcp__comfy-cloud__generate-image`, `/mcp__comfy-cloud__search-models`, and so on (the `/mcp__<name>__` prefix uses the name you passed to `claude mcp add`). The plugin above is recommended because it wraps these as the friendlier `/comfy-cloud:*` commands.
141+
This path still exposes the same workflows as MCP prompts: `/mcp__comfy-cloud__generate-image`, `/mcp__comfy-cloud__search-models`, and so on (the `/mcp__<name>__` prefix uses the name you passed to `claude mcp add`). The plugin above is recommended because it wraps these as the friendlier `/comfy-cloud:*` commands.
82142
</Accordion>
83143

84144
### <span style={{ marginRight: "0.6rem" }}><Icon icon="desktop" size={22} /></span> Claude Desktop
@@ -118,6 +178,23 @@ Claude Desktop adds Comfy Cloud as a **custom connector** through its UI, then r
118178
</Step>
119179
</Steps>
120180

181+
Claude Desktop does not support Claude Code slash commands. Instead, open the **prompt picker** for the same workflows:
182+
183+
| Prompt | Description |
184+
| --- | --- |
185+
| `generate-image` | Generate an image from a text description |
186+
| `generate-video` | Generate a video from text or an image |
187+
| `generate-audio` | Generate audio, music, or sound effects |
188+
| `generate-3d` | Generate a 3D model from text or an image |
189+
| `upscale-image` | Upscale an image to higher resolution |
190+
| `remove-background` | Remove the background from an image |
191+
| `search-templates` | Find pre-built workflow templates |
192+
| `search-models` | Search for models (checkpoints, LoRAs, VAEs) |
193+
| `search-nodes` | Search nodes and get wiring suggestions |
194+
| `help` | See what you can do with ComfyUI Cloud |
195+
196+
You can also skip prompts and ask in plain language. The MCP tools work the same way.
197+
121198
### Headless / CI (API key)
122199

123200
Claude Code and Claude Desktop use OAuth, so you do not need an API key. For **headless or CI** setups where no browser is available, authenticate with an API key instead:
@@ -133,12 +210,28 @@ Claude Code and Claude Desktop use OAuth, so you do not need an API key. For **h
133210
</Step>
134211
</Steps>
135212

213+
## Outputs and downloads
214+
215+
The MCP server runs in the cloud and **never writes files to your machine**. When a generation completes, your agent calls `get_output`, which returns:
216+
217+
1. A **temporary signed download URL** (valid for a short window).
218+
2. A ready-to-run **shell command** (`curl` on macOS and Linux, `curl.exe` on Windows).
219+
220+
Your agent should run that command in your shell. The command includes the destination path and filename.
221+
222+
<Warning>
223+
Run the returned command **verbatim**. Do not re-encode or edit the signed URL. The signature lives in the query string and breaks if the URL is modified.
224+
</Warning>
225+
226+
If your MCP client cannot run shell commands (some GUI-only setups), copy the command and run it yourself in a terminal.
227+
136228
## Related resources
137229

138230
| Resource | What it's for |
139231
| --- | --- |
140232
| [Comfy Skills](https://github.com/Comfy-Org/comfy-skills/) | Claude Code plugin marketplace and community skill library. The **comfy-cloud** plugin used above is distributed here; browse or contribute additional skills for Comfy workflows. |
141233
| [Comfy CLI](/agent-tools/comfy-cli) | Command-line tool for local ComfyUI install/launch and for calling hosted partner nodes from scripts or CI (`comfy generate`, in beta). Complements MCP when you need terminal or automation workflows. |
234+
| [Share a workflow on Comfy Cloud](/cloud/share-workflow) | Share workflows from the Comfy Cloud UI (the MCP `share_workflow` tool does this from an agent session). |
142235

143236
## Feedback
144237

@@ -147,25 +240,44 @@ Comfy Cloud MCP is in public beta. Please try it out and tell us what works and
147240
- **[Feedback survey](https://links.comfy.org/cloudmcpbeta)**: report bugs, request features, or share general impressions.
148241
- **Discord**: [#comfy-mcp-and-cli](https://discord.gg/xWJn6nhE3R) on the Comfy Discord for questions and discussion.
149242

243+
## Known limitations
244+
245+
Comfy Cloud MCP is an early release. These limitations are known and being worked on:
246+
247+
**Workflows**
248+
249+
- **Saved workflows cannot be run by ID.** Your agent can list and inspect saved workflows, but must reconstruct or convert them to API format before execution.
250+
- **Generated assets may not embed workflow metadata.** Images created via MCP might not reopen the workflow when opened in ComfyUI.
251+
- **Workflow building depends on agent accuracy.** Complex multi-node workflows may need a retry or refinement.
252+
253+
**File handling**
254+
255+
- **Outputs require a shell download step.** See [Outputs and downloads](#outputs-and-downloads).
256+
- **Upload size limits** may apply depending on your MCP client. Some clients impose their own limits on file uploads.
257+
258+
**Authentication**
259+
260+
- **OAuth or API key.** Claude Code and Claude Desktop use a one-time browser OAuth flow. Headless clients can pass a Comfy Cloud API key via the `X-API-Key` header instead. A device-code OAuth flow for clients that cannot open a browser is planned.
261+
150262
## FAQ
151263

152264
<AccordionGroup>
153265
<Accordion title="Which clients are supported?">
154266
Claude Code and Claude Desktop today, both signing in with OAuth. Support for more clients is coming.
155267
</Accordion>
156268
<Accordion title="Do I need an API key?">
157-
Not for Claude Code or Claude Desktop — they use OAuth. An API key is only needed for headless or CI setups with no browser.
269+
Not for Claude Code or Claude Desktop. They use OAuth. An API key is only needed for headless or CI setups with no browser.
158270
</Accordion>
159271
<Accordion title="Do the slash commands work in Claude Desktop?">
160-
No. The slash commands ship in the Claude Code plugin. Claude Desktop connects to the same MCP server (so the tools work — just ask in plain language), but it doesn't support Claude Code plugins or slash commands.
272+
No. Slash commands ship in the Claude Code plugin. Claude Desktop connects to the same MCP server (the tools work if you ask in plain language or use the prompt picker), but it does not support Claude Code plugins or slash commands.
161273
</Accordion>
162274
<Accordion title="I typed /comfy or /cloud and nothing came up.">
163275
There is no `/comfy` or `/cloud` command. Commands appear under one of two prefixes depending on how you connected:
164276

165277
- **Plugin (recommended):** `/comfy-cloud:generate-image`, `/comfy-cloud:generate-video`, … — type `/comfy-cloud:` to see them all.
166278
- **Direct connection (no plugin):** `/mcp__comfy-cloud__generate-image`, … — type `/mcp__` to see them.
167279

168-
Either way you can also just ask in plain language ("generate an image of …") — the MCP tools are model-invoked and don't need a slash command.
280+
Either way you can also just ask in plain language ("generate an image of …"). The MCP tools are model-invoked and do not require a slash command.
169281
</Accordion>
170282
<Accordion title="The sign-in did not open a browser.">
171283
In Claude Code, run `/mcp`, select **comfy-cloud**, and choose **Authenticate**. In Claude Desktop, reopen the connector from **Customize → Connectors** and trigger sign-in.

agent-tools/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ComfyUI provides **MCP servers** and **Comfy CLI** so AI agents and developers c
1313

1414
<CardGroup cols={2}>
1515
<Card title="Comfy Cloud MCP" icon="cloud" href="/agent-tools/cloud">
16-
Connect to the hosted MCP server at <code>cloud.comfy.org</code>. Runs workflows on Cloud GPUs, uses pre-installed models, and searches the full template library.
16+
Connect to the hosted MCP server at <code>cloud.comfy.org/mcp</code>. Generate images, video, audio, and 3D on Cloud GPUs, search templates/models/nodes, run workflows, and share saved workflows from chat.
1717
</Card>
1818
<Card title="Comfy Partner MCP" icon="plug" href="/agent-tools/partner-mcp">
1919
Run a local MCP server using the Comfy Partner-Node SDK. Provides unified <code>generate_image</code>, <code>generate_video</code>, <code>generate_3d</code>, and more tools across 30+ partner providers.

0 commit comments

Comments
 (0)