Skip to content

Expand Comfy Cloud MCP user docs and sync i18n#1204

Merged
comfyui-wiki merged 1 commit into
mainfrom
docs/cloud-mcp-user-guide
Jun 30, 2026
Merged

Expand Comfy Cloud MCP user docs and sync i18n#1204
comfyui-wiki merged 1 commit into
mainfrom
docs/cloud-mcp-user-guide

Conversation

@comfyui-wiki

Copy link
Copy Markdown
Member

Document MCP tools, outputs, workflow sharing, and known limitations so users know what agents can do without server-side setup details.

Document MCP tools, outputs, workflow sharing, and known limitations so users know what agents can do without server-side setup details.
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The English agent-tools/cloud.mdx is rewritten with a revised overview, structured MCP tool tables (Discovery/Execution/Saved/Sharing), updated Claude Code slash-command list, new Claude Desktop prompt-picker guidance, an Outputs and downloads section, Known limitations, and a refreshed FAQ. All changes are propagated to Japanese, Korean, and Chinese translations, and index card descriptions are updated across all locales.

Changes

Comfy Cloud MCP Docs Refresh

Layer / File(s) Summary
English overview, MCP tools, and index card
agent-tools/cloud.mdx, agent-tools/index.mdx
Opening overview and execution model are rewritten; MCP tools section is restructured into Discovery/Execution/Saved workflows/Sharing workflows tables; index card now targets cloud.comfy.org/mcp with expanded capability list.
Claude Code and Claude Desktop install guidance
agent-tools/cloud.mdx
Claude Code slash-command table gains audio and 3D generation entries; raw MCP prompt path note is adjusted; Claude Desktop section is replaced with prompt-picker table and a note that plain-language requests work without prompts.
Outputs/downloads, known limitations, and FAQ
agent-tools/cloud.mdx
New Outputs and downloads section documents signed URL retrieval and a verbatim curl command warning; Known limitations section is introduced; FAQ accordions are rewritten for supported clients, API key requirements, Claude Desktop behavior, and command prefix modes — quite a doc-tacular transformation!
Chinese translation sync
zh/agent-tools/cloud.mdx, zh/agent-tools/index.mdx
Frontmatter hashes refreshed; overview, tool tables, Claude Code/Desktop install steps, headless/CI API-key section, outputs, limitations, and FAQ all updated to match English source; index card URL and capability text adjusted.
Japanese translation sync
ja/agent-tools/cloud.mdx, ja/agent-tools/index.mdx
Frontmatter hashes and block hashes updated; overview through Claude Desktop sections replaced with translated new install steps, slash-command table, and prompt-picker table; index card wording and section text revised.
Korean translation sync
ko/agent-tools/cloud.mdx, ko/agent-tools/index.mdx
Frontmatter description and hashes updated; overview, tool tables, Claude Code/Desktop flows, headless/CI section, and outputs/limitations/FAQ content translated to match English source; index page title changed to English and card description rewritten.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cloud-mcp-user-guide
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/cloud-mcp-user-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@comfyui-wiki comfyui-wiki merged commit 3dd3ce8 into main Jun 30, 2026
7 of 8 checks passed
@github-actions github-actions Bot deleted the docs/cloud-mcp-user-guide branch June 30, 2026 17:48

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@agent-tools/cloud.mdx`:
- Around line 277-278: The FAQ bullets in the cloud docs use em dashes, which
should be replaced with allowed punctuation. Update the two bullet lines in the
relevant MDX section to use a period or colon instead of the `—`, keeping the
existing meaning and format intact; use the surrounding bullet text with
`/comfy-cloud:generate-image` and `/mcp__comfy-cloud__generate-image` to locate
the lines.

In `@ja/agent-tools/cloud.mdx`:
- Line 267: The fragment links are broken because they point to English slugs
that do not match the localized headings in this markdown file. Update the
target headings in the relevant sections (for example, the headings referenced
by the output/downloads and local ComfyUI links) to have explicit matching ids,
or change the links to use the actual localized slugs so the references resolve
correctly.

In `@ko/agent-tools/cloud.mdx`:
- Line 52: The subsection headings in the Korean docs page are still left in
English. Update the heading text used for the Discovery, Execution, Saved
workflows, and Sharing workflows sections in the cloud.mdx content so they are
translated consistently with the rest of the page, keeping the section structure
unchanged.
- Line 82: The markdown links in this KO doc use stale English fragments that do
not match the localized headings, so fix the anchors in the affected sections by
either adding stable explicit ids to the target headings or changing the href
fragments to the actual localized slugs. Check the links around the references
to known limitations, outputs and downloads, and the local ComfyUI section, and
ensure the corresponding heading ids in this document are consistent so the
jumps resolve correctly.

In `@ko/agent-tools/index.mdx`:
- Line 2: The page title in the KO docs frontmatter is reverting to English, so
update the title field in the Agent Tools / MCP metadata to a Korean-localized
value to match sidebarTitle and the rest of the localized page content. Keep the
change limited to the frontmatter title so tabs and search previews stay
consistent with the KO page.

In `@zh/agent-tools/cloud.mdx`:
- Line 82: The in-page links in the ZH docs likely point to broken anchors
because the referenced headings are localized and may not have matching ids.
Update the fragment targets in the relevant markdown/mdx content around the
`cloud.mdx` sections so they explicitly match the actual localized heading ids
for `known-limitations`, `outputs-and-downloads`, and
`what-about-local-comfyui`, and verify the links resolve correctly from the
`cloud.mdx` and `/zh/agent-tools` pages.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 8283b04f-afb7-470e-889b-004b065d9fa2

📥 Commits

Reviewing files that changed from the base of the PR and between 3664a9a and 5930796.

📒 Files selected for processing (8)
  • agent-tools/cloud.mdx
  • agent-tools/index.mdx
  • ja/agent-tools/cloud.mdx
  • ja/agent-tools/index.mdx
  • ko/agent-tools/cloud.mdx
  • ko/agent-tools/index.mdx
  • zh/agent-tools/cloud.mdx
  • zh/agent-tools/index.mdx

Comment thread agent-tools/cloud.mdx
Comment on lines 277 to 278
- **Plugin (recommended):** `/comfy-cloud:generate-image`, `/comfy-cloud:generate-video`, … — type `/comfy-cloud:` to see them all.
- **Direct connection (no plugin):** `/mcp__comfy-cloud__generate-image`, … — type `/mcp__` to see them.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Replace the em dashes in these FAQ bullets.

These two lines use , which the English MDX rules forbid. Tiny tweak, tidy streak. Use a period or colon instead. As per coding guidelines, "In English MDX documentation, avoid em dashes (); prefer periods, commas, or colons instead."

✏️ Suggested wording
-    - **Plugin (recommended):** `/comfy-cloud:generate-image`, `/comfy-cloud:generate-video`, … — type `/comfy-cloud:` to see them all.
-    - **Direct connection (no plugin):** `/mcp__comfy-cloud__generate-image`, … — type `/mcp__` to see them.
+    - **Plugin (recommended):** `/comfy-cloud:generate-image`, `/comfy-cloud:generate-video`, … Type `/comfy-cloud:` to see them all.
+    - **Direct connection (no plugin):** `/mcp__comfy-cloud__generate-image`, … Type `/mcp__` to see them.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Plugin (recommended):** `/comfy-cloud:generate-image`, `/comfy-cloud:generate-video`, … — type `/comfy-cloud:` to see them all.
- **Direct connection (no plugin):** `/mcp__comfy-cloud__generate-image`, … — type `/mcp__` to see them.
- **Plugin (recommended):** `/comfy-cloud:generate-image`, `/comfy-cloud:generate-video`, … Type `/comfy-cloud:` to see them all.
- **Direct connection (no plugin):** `/mcp__comfy-cloud__generate-image`, … Type `/mcp__` to see them.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@agent-tools/cloud.mdx` around lines 277 - 278, The FAQ bullets in the cloud
docs use em dashes, which should be replaced with allowed punctuation. Update
the two bullet lines in the relevant MDX section to use a period or colon
instead of the `—`, keeping the existing meaning and format intact; use the
surrounding bullet text with `/comfy-cloud:generate-image` and
`/mcp__comfy-cloud__generate-image` to locate the lines.

Source: Coding guidelines

Comment thread ja/agent-tools/cloud.mdx

**ファイル処理**

- **出力にはシェルダウンロード手順が必要です。** [出力とダウンロード](#outputs-and-downloads) を参照してください。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Fix the broken fragment links.

Line 267 links to #outputs-and-downloads, but this page’s heading is ## 出力とダウンロード and no matching explicit id is shown. Line 298 has the same issue for /ja/agent-tools#what-about-local-comfyui against the localized index heading. These links will blink, not link. Add explicit English ids on the target headings or switch these fragments to the real localized slugs.

Also applies to: 298-298

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ja/agent-tools/cloud.mdx` at line 267, The fragment links are broken because
they point to English slugs that do not match the localized headings in this
markdown file. Update the target headings in the relevant sections (for example,
the headings referenced by the output/downloads and local ComfyUI links) to have
explicit matching ids, or change the links to use the actual localized slugs so
the references resolve correctly.

Comment thread ko/agent-tools/cloud.mdx

연결되면 에이전트가 액세스할 수 있는 도구입니다. 이름은 MCP 클라이언트 로그 및 디버깅에 표시되는 것과 일치합니다.

### Discovery

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Translate the subsection headings too.

Discovery, Execution, Saved workflows, and Sharing workflows are still in English inside an otherwise Korean page. That reads like a half-synced translation and makes the tables harder to scan.

Also applies to: 61-61, 73-73, 85-85

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ko/agent-tools/cloud.mdx` at line 52, The subsection headings in the Korean
docs page are still left in English. Update the heading text used for the
Discovery, Execution, Saved workflows, and Sharing workflows sections in the
cloud.mdx content so they are translated consistently with the rest of the page,
keeping the section structure unchanged.

Comment thread ko/agent-tools/cloud.mdx
| `save_workflow` | 워크플로를 Comfy Cloud 계정에 저장 |

<Note>
저장된 워크플로를 찾아보고 검사할 수 있지만, 현재 에이전트가 ID로 직접 실행할 수는 없습니다. 저장된 워크플로는 ComfyUI 그래프 형식을 사용하며 실행 전에 API 형식으로 변환해야 합니다. [알려진 제한 사항](#known-limitations)을 참조하세요.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Repair the stale English anchors.

Line 82 points to #known-limitations, Line 267 to #outputs-and-downloads, and Line 298 to /ko/agent-tools#what-about-local-comfyui, but the visible headings in these KO pages are localized and no matching explicit ids are shown. Those jumps are likely dead on arrival. Add stable explicit ids to the target headings or update the fragments to the actual localized slugs.

Also applies to: 267-267, 298-298

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ko/agent-tools/cloud.mdx` at line 82, The markdown links in this KO doc use
stale English fragments that do not match the localized headings, so fix the
anchors in the affected sections by either adding stable explicit ids to the
target headings or changing the href fragments to the actual localized slugs.
Check the links around the references to known limitations, outputs and
downloads, and the local ComfyUI section, and ensure the corresponding heading
ids in this document are consistent so the jumps resolve correctly.

Comment thread ko/agent-tools/index.mdx
@@ -1,9 +1,9 @@
---
title: "에이전트 도구 / MCP"
title: "Agent Tools / MCP"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Keep the KO page title localized.

Line 2 switches the page title back to English while sidebarTitle and the rest of the page stay Korean. That inconsistency will surface in tabs and search previews.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ko/agent-tools/index.mdx` at line 2, The page title in the KO docs
frontmatter is reverting to English, so update the title field in the Agent
Tools / MCP metadata to a Korean-localized value to match sidebarTitle and the
rest of the localized page content. Keep the change limited to the frontmatter
title so tabs and search previews stay consistent with the KO page.

Comment thread zh/agent-tools/cloud.mdx
| `save_workflow` | 将工作流保存到您的 Comfy Cloud 账户 |

<Note>
您可以浏览和检查已保存的工作流,但代理目前无法直接通过 ID 运行它们。已保存的工作流使用 ComfyUI 图格式,在执行前必须转换为 API 格式。请参阅<a href="#known-limitations">已知限制</a>。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Update the fragment ids before these links go hinky.

Line 82 uses #known-limitations, Line 267 uses #outputs-and-downloads, and Line 298 uses /zh/agent-tools#what-about-local-comfyui, but the corresponding headings in the ZH docs are localized and no explicit matching ids are shown. These anchors are likely broken.

Also applies to: 267-267, 298-298

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@zh/agent-tools/cloud.mdx` at line 82, The in-page links in the ZH docs likely
point to broken anchors because the referenced headings are localized and may
not have matching ids. Update the fragment targets in the relevant markdown/mdx
content around the `cloud.mdx` sections so they explicitly match the actual
localized heading ids for `known-limitations`, `outputs-and-downloads`, and
`what-about-local-comfyui`, and verify the links resolve correctly from the
`cloud.mdx` and `/zh/agent-tools` pages.

@mintlify

mintlify Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
comfy 🔴 Failed Jun 30, 2026, 5:54 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant