Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 135 additions & 0 deletions cloud/mcp.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
---
title: "Connect to Claude (MCP)"
description: "Use Comfy Cloud from Claude Code and Claude Desktop through the Comfy Cloud MCP server — generate images, video, audio, and 3D, search models and nodes, and run workflows."
---

import CloudFeature from '/snippets/cloud-feature.mdx'

<CloudFeature/>

## Overview

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.

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.

## Install

Pick your client:

<CardGroup cols={2}>
<Card title="Claude Code" icon="terminal" href="#claude-code">

Check warning on line 21 in cloud/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

cloud/mcp.mdx#L21

Did you really mean 'claude'?
Install the plugin — connection and commands in one step.
</Card>
<Card title="Claude Desktop" icon="desktop" href="#claude-desktop">
Add a custom connector in the app, then sign in.
</Card>
</CardGroup>

### <span style={{ marginRight: "0.6rem" }}><Icon icon="terminal" size={22} /></span> Claude Code

Install the **comfy-cloud** plugin — it adds the MCP connection and the slash commands in one step.

<Steps>
<Step title="Add the marketplace">
```
/plugin marketplace add Comfy-Org/comfy-skills
```
</Step>
<Step title="Install the plugin">
```
/plugin install comfy-cloud@comfy-skills
```
</Step>
<Step title="Sign in">
Run `/mcp`, select **comfy-cloud** → **Authenticate**. Your browser opens to sign in, and tokens refresh automatically.
</Step>
</Steps>

The plugin adds these slash commands:

| Command | What it does |
| --- | --- |
| `/comfy-cloud:generate-image` | Generate, edit, or modify an image |
| `/comfy-cloud:generate-video` | Generate, edit, or extend a video |
| `/comfy-cloud:generate-audio` | Generate audio |
| `/comfy-cloud:generate-3d` | Generate a 3D model |
| `/comfy-cloud:remove-background` | Remove the background from an image |
| `/comfy-cloud:upscale-image` | Upscale an image |
| `/comfy-cloud:search-models` | Search available models |
| `/comfy-cloud:search-nodes` | Search for nodes |
| `/comfy-cloud:search-templates` | Find pre-built workflows |
| `/comfy-cloud:help` | See what you can do |

<Accordion title="Prefer just the connection, without the plugin?">
Add the server directly (no slash commands):

```bash
claude mcp add --transport http comfy-cloud https://cloud.comfy.org/mcp
```

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

### <span style={{ marginRight: "0.6rem" }}><Icon icon="desktop" size={22} /></span> Claude Desktop

Claude Desktop adds Comfy Cloud as a **custom connector** through its UI, then runs the OAuth sign-in.

<Steps>
<Step title="Open Connectors">
In Claude Desktop, open **Customize**, then choose **Connectors**.

![Claude Desktop Connectors](/images/cloud/mcp/desktop-connectors.png)
</Step>
<Step title="Add a custom connector">
Click the **+** button, then choose **Add custom connector**.

![Add custom connector](/images/cloud/mcp/desktop-add-custom-connector.png)
</Step>
<Step title="Enter the server URL">
Name it anything (for example, *Comfy Cloud*) and set the **Remote MCP server URL** to:

```
https://cloud.comfy.org/mcp
```

![Connector details](/images/cloud/mcp/desktop-connector-url.png)
</Step>
<Step title="Sign in">
Click **Add**, then sign in through Claude Desktop when prompted. You are connected.

![Sign in through Claude Desktop](/images/cloud/mcp/desktop-signin.png)
</Step>
</Steps>

### Headless / CI (API key)

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:

<Steps>
<Step title="Create a key">
Go to [platform.comfy.org/profile/api-keys](https://platform.comfy.org/profile/api-keys), click **New API Key**, and copy it (it starts with `comfyui-`).
</Step>
<Step title="Add the server with the key header">
```bash
claude mcp add --transport http comfy-cloud https://cloud.comfy.org/mcp -H "X-API-Key: comfyui-…"

Check warning on line 115 in cloud/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

cloud/mcp.mdx#L115

Did you really mean 'mcp'?
```
</Step>
</Steps>

## FAQ

<AccordionGroup>
<Accordion title="Which clients are supported?">
Claude Code and Claude Desktop today, both signing in with OAuth. Support for more clients is coming.
</Accordion>
<Accordion title="Do I need an API key?">
Not for Claude Code or Claude Desktop — they use OAuth. An API key is only needed for headless or CI setups with no browser.
</Accordion>
<Accordion title="Do the slash commands work in Claude Desktop?">
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.
</Accordion>
<Accordion title="The sign-in did not open a browser.">
In Claude Code, run `/mcp`, select **comfy-cloud**, and choose **Authenticate**. In Claude Desktop, reopen the connector from **Customize → Connectors** and trigger sign-in.
</Accordion>
</AccordionGroup>
28 changes: 9 additions & 19 deletions development/cloud/mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
**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](https://form.typeform.com/to/hHmvw1UH).
</Warning>

Comfy Cloud MCP connects AI assistants — including Claude Desktop, Claude Code, Cursor, and Amp — to [Comfy Cloud](https://cloud.comfy.org) via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io). 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.

Check warning on line 12 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L12

Did you really mean 'GPUs'?

## Quick Start

Expand All @@ -23,7 +23,15 @@

**OAuth (no API key to paste)** — In **Claude Code** or **Claude Desktop**, add the remote server `https://cloud.comfy.org/mcp` and use the client’s **Authenticate** control to sign in with your Comfy account. Partner generation and workflows use the same tools once connected.

**API key** — Still fully supported. Use the one-click installer or manual setup below if your client does not offer OAuth, or if you prefer a key.
For **Claude web & Desktop**, the fastest way to add the server is the one-click Connectors link — no config file to edit:

<CardGroup cols={1}>
<Card title="Add Comfy Cloud to Claude" icon="plug" href="https://claude.ai/customize/connectors?modal=add-custom-connector&connectorName=Comfy%20Cloud&connectorUrl=https%3A%2F%2Fcloud.comfy.org%2Fmcp">

Check warning on line 29 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L29

Did you really mean 'claude'?
Opens Claude’s **Add custom connector** dialog with the Comfy Cloud server URL (`https://cloud.comfy.org/mcp`) pre-filled. Click **Add**, then **Connect** to sign in with OAuth. Custom connectors require a paid Claude plan (Pro, Max, Team, or Enterprise). OAuth sign-in is still rolling out (see the note below) — until it works for you, use an API key.
</Card>
</CardGroup>

**API key** — Still fully supported. Use the manual setup below if your client does not offer OAuth, or if you prefer a key.

<Warning>
**OAuth rollout.** The MCP server already accepts OAuth on production, but sign-in may not work end-to-end for everyone until the next Comfy Cloud production deployment finishes (the discovery endpoint must catch up). Until OAuth works for you, use an API key — existing API-key setups are unchanged.
Expand All @@ -37,24 +45,6 @@
</Card>
</CardGroup>

### Install & Connect (API key)

The one-click installer 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.

<Tabs>
<Tab title="macOS / Linux">
```bash
curl -fsSL https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.sh | bash
```
</Tab>

<Tab title="Windows (PowerShell)">
```powershell
irm https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.ps1 | iex
```
</Tab>
</Tabs>

### Manual setup with API key

Comfy Cloud MCP is hosted at `https://cloud.comfy.org/mcp`. Point your MCP client at that URL with your API key:
Expand All @@ -62,7 +52,7 @@
<Tabs>
<Tab title="Claude Code">
```bash
claude mcp add comfyui-cloud \

Check warning on line 55 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L55

Did you really mean 'mcp'?
--transport http \
https://cloud.comfy.org/mcp \
-H "X-API-Key: your-api-key-here"
Expand Down Expand Up @@ -128,12 +118,12 @@

| Path | Tool | Best for |
|:-----|:-----|:---------|
| **Partner APIs** | `partner_generate` | Named providers (Flux, Grok, Nano Banana, Ideogram, GPT-image, Seedream, etc.) |

Check warning on line 121 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L121

Did you really mean 'Nano'?

Check warning on line 121 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L121

Did you really mean 'Seedream'?
| **Custom workflows** | `submit_workflow` | Open-source models, LoRA/ControlNet, multi-step graphs, or anything not covered by `partner_generate` |

For partner providers, `partner_generate` **always tries a real Comfy Cloud workflow run first**. The output is saved to your asset library with the workflow embedded so you can reopen it in the editor. The tool returns a `prompt_id` — poll with `get_job_status`, then download with `get_output` (same as any other workflow).

For image-input requests or models not yet on the persistable set, the server **falls back automatically** to a direct partner-proxy response with instant download URLs. That fallback is internal; you cannot opt into or out of it. Those direct results are **not** saved to the asset library.

Check warning on line 126 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L126

Did you really mean 'persistable'?

## Available Tools

Expand All @@ -151,7 +141,7 @@

| Tool | Description |
|:-----|:------------|
| `partner_generate` | Generate with partner APIs (Flux, Nano Banana, Grok, GPT-image, Ideogram, Seedream, etc.). Runs through a Comfy Cloud workflow by default; returns `prompt_id` and saves to your asset library. Poll `get_job_status` / `get_output` like any workflow. Unsupported cases fall back to instant proxy URLs automatically. |

Check warning on line 144 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L144

Did you really mean 'Nano'?

Check warning on line 144 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L144

Did you really mean 'Seedream'?

### Discovery

Expand Down Expand Up @@ -214,7 +204,7 @@
└──────────────┘ └─────────────────────────────────────────────┘
```

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.

Check warning on line 207 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L207

Did you really mean 'GPUs'?

For partner models, the agent typically calls `partner_generate` first (workflow + library save). For everything else it uses discovery tools (`search_templates`, `search_nodes`, `cql`), builds ComfyUI API-format workflow JSON, and submits via `submit_workflow` — just describe what you want in natural language.

Expand Down Expand Up @@ -267,7 +257,7 @@
- **`run_saved_workflow` coverage.** The tool fetches a saved workflow, converts save format → API format, and submits it. Complex input overrides or workflows with unsupported nodes may still need manual fixes or a rebuild via `submit_workflow`.
- **Workflow metadata varies by path.** Outputs from `partner_generate` (workflow path) land in the asset library with the graph embedded for reopening in the editor. Outputs from `submit_workflow` or the direct `partner_generate` fallback may not include full workflow metadata in the asset library.
- **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.
- **`partner_generate` scope.** Text-to-image on the persistable model set runs as a saved workflow. Image-input generations, unmapped models, and non-image modalities use the direct proxy fallback (instant URL, not library-persisted) until workflow persist support expands.

Check warning on line 260 in development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/mcp-server.mdx#L260

Did you really mean 'persistable'?

**File Handling**
- **Upload size limits** may apply depending on your MCP client.
Expand Down
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@
"icon": "cloud",
"pages": [
"cloud/share-workflow",
"cloud/import-models"
"cloud/import-models",
"cloud/mcp"
]
}
]
Expand Down
Binary file added images/cloud/mcp/desktop-add-custom-connector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/mcp/desktop-connector-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/mcp/desktop-connectors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/mcp/desktop-signin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 9 additions & 19 deletions ja/development/cloud/mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,15 @@

**OAuth(API キーの貼り付け不要)** — **Claude Code** または **Claude Desktop** でリモートサーバー `https://cloud.comfy.org/mcp` を追加し、クライアントの **Authenticate** から Comfy アカウントでサインインします。接続後はパートナー生成もワークフローも同じツールで利用できます。

**API キー** — 引き続き完全にサポートされています。OAuth に未対応のクライアント、またはキーを使いたい場合は、下記のワンクリックインストールまたは手動設定をご利用ください。
**Claude(Web・Desktop)** では、ワンクリックの Connectors リンクが最速です。設定ファイルの編集は不要です:

<CardGroup cols={1}>
<Card title="Comfy Cloud を Claude に追加" icon="plug" href="https://claude.ai/customize/connectors?modal=add-custom-connector&connectorName=Comfy%20Cloud&connectorUrl=https%3A%2F%2Fcloud.comfy.org%2Fmcp">

Check warning on line 29 in ja/development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

ja/development/cloud/mcp-server.mdx#L29

Did you really mean 'claude'?
Claude の **カスタムコネクタを追加** ダイアログを、Comfy Cloud のサーバー URL(`https://cloud.comfy.org/mcp`)が事前入力された状態で開きます。**追加** をクリックし、**接続** で OAuth サインインします。カスタムコネクタには有料の Claude プラン(Pro、Max、Team、Enterprise)が必要です。OAuth サインインは段階的に展開中です(下記の注意を参照)。利用できるようになるまでは API キーをご利用ください。
</Card>
</CardGroup>

**API キー** — 引き続き完全にサポートされています。OAuth に未対応のクライアント、またはキーを使いたい場合は、下記の手動設定をご利用ください。

<Warning>
**OAuth の段階的ロールアウト。** MCP サーバーは本番で OAuth を受け付けますが、次の Comfy Cloud 本番デプロイが完了するまで(ディスカバリーエンドポイントの同期が必要)、一部のユーザーでは端到端のサインインがまだ動作しない場合があります。OAuth が使えない間は API キーをご利用ください。既存の API キー設定に変更はありません。
Expand All @@ -37,24 +45,6 @@
</Card>
</CardGroup>

### インストールと接続(API キー)

ワンクリックインストーラは MCP クライアント(Claude Code、Cursor、Amp)を自動検出し、Comfy API キーを確認してリモート MCP サーバーを設定します。Node.js やその他の依存関係は不要です。

<Tabs>
<Tab title="macOS / Linux">
```bash
curl -fsSL https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.sh | bash
```
</Tab>

<Tab title="Windows (PowerShell)">
```powershell
irm https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.ps1 | iex
```
</Tab>
</Tabs>

### API キーで手動設定

Comfy Cloud MCPは `https://cloud.comfy.org/mcp` でホストされています。MCP クライアントをその URL に向け、API キーを設定します:
Expand All @@ -62,7 +52,7 @@
<Tabs>
<Tab title="Claude Code">
```bash
claude mcp add comfyui-cloud \

Check warning on line 55 in ja/development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

ja/development/cloud/mcp-server.mdx#L55

Did you really mean 'mcp'?
--transport http \
https://cloud.comfy.org/mcp \
-H "X-API-Key: your-api-key-here"
Expand Down
28 changes: 9 additions & 19 deletions zh/development/cloud/mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,15 @@

**OAuth(无需粘贴 API 密钥)** — 在 **Claude Code** 或 **Claude Desktop** 中添加远程服务器 `https://cloud.comfy.org/mcp`,使用客户端的 **Authenticate** 通过 Comfy 账号登录。连接成功后,合作节点生成与工作流工具用法相同。

**API 密钥** — 仍完全支持。若客户端不支持 OAuth,或你更习惯使用密钥,请使用下方的一键安装或手动配置。
对于 **Claude(网页版与桌面版)**,最快的添加方式是一键 Connectors 链接——无需编辑配置文件:

<CardGroup cols={1}>
<Card title="将 Comfy Cloud 添加到 Claude" icon="plug" href="https://claude.ai/customize/connectors?modal=add-custom-connector&connectorName=Comfy%20Cloud&connectorUrl=https%3A%2F%2Fcloud.comfy.org%2Fmcp">

Check warning on line 29 in zh/development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

zh/development/cloud/mcp-server.mdx#L29

Did you really mean 'claude'?
打开 Claude 的 **添加自定义连接器** 对话框,并预填 Comfy Cloud 服务器 URL(`https://cloud.comfy.org/mcp`)。点击 **添加**,然后点击 **连接** 通过 OAuth 登录。自定义连接器需要付费的 Claude 套餐(Pro、Max、Team 或 Enterprise)。OAuth 登录仍在逐步开放(见下方说明)——在可用之前请使用 API 密钥。
</Card>
</CardGroup>

**API 密钥** — 仍完全支持。若客户端不支持 OAuth,或你更习惯使用密钥,请使用下方的手动配置。

<Warning>
**OAuth 逐步开放。** MCP 服务端已在生产环境支持 OAuth,但在下一次 Comfy Cloud 生产部署完成前(发现端点需同步更新),部分用户可能还无法完成端到端登录。若 OAuth 暂时不可用,请继续使用 API 密钥——现有 API 密钥配置不受影响。
Expand All @@ -37,24 +45,6 @@
</Card>
</CardGroup>

### 安装与连接(API 密钥)

一键安装脚本会自动检测你的 MCP 客户端(Claude Code、Cursor、Amp),询问 Comfy API 密钥并配置远程 MCP 服务器——无需 Node.js 或其他依赖。

<Tabs>
<Tab title="macOS / Linux">
```bash
curl -fsSL https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.sh | bash
```
</Tab>

<Tab title="Windows (PowerShell)">
```powershell
irm https://raw.githubusercontent.com/Comfy-Org/comfy-cloud-mcp/main/install.ps1 | iex
```
</Tab>
</Tabs>

### 使用 API 密钥手动配置

Comfy Cloud MCP 托管在 `https://cloud.comfy.org/mcp`。将 MCP 客户端指向该 URL 并提供 API 密钥:
Expand All @@ -62,7 +52,7 @@
<Tabs>
<Tab title="Claude Code">
```bash
claude mcp add comfyui-cloud \

Check warning on line 55 in zh/development/cloud/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

zh/development/cloud/mcp-server.mdx#L55

Did you really mean 'mcp'?
--transport http \
https://cloud.comfy.org/mcp \
-H "X-API-Key: your-api-key-here"
Expand Down