docs(agent-tools): sync Cloud MCP docs with server v0.28.1 — full tool list, spend gating, saved-workflow execution#1217
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Hand-translated to mirror the English update, then re-stamped translationSourceHash/translationBlockHashes via the repo's own chunked-translate helpers so getSectionSyncStatus reports up-to-date for all three languages. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
📝 WalkthroughWalkthroughDocumentation for Comfy Cloud MCP (agent-tools/cloud.mdx and ja/ko/zh translations) was rewritten: the typical flow now details discovery, generation, and retrieval steps; MCP tools are reorganized into Discovery, Generation, Jobs and batches, and Saved workflows; new Apps/links, Account/session, and Credits and spending sections were added; known limitations and FAQ were updated. ChangesComfy Cloud MCP documentation update
No sequence diagram needed here — this PR is doc-shuffling, not flow-truffling (docs-only changes with no new multi-component control flow). Possibly related PRs
Poem 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
ko/agent-tools/cloud.mdx (1)
53-53: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winSection headers left untranslated.
"Discovery", "Generation", "Jobs and batches", "Saved workflows", "Apps and links", and "Account and session" headers remain in English here, while the equivalent ja/zh files fully localize these same headers (e.g. ja uses "検索"/"生成"/"ジョブとバッチ"..., zh uses "发现"/"生成"/"作业与批处理"...). Since this PR re-stamps the translation hashes to mark the section as synchronized, the headers should be localized to match.
Also applies to: 66-66, 76-76, 88-88, 107-107, 115-115
🤖 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 53, The section headers in cloud.mdx are still in English while the localized ja/zh versions translate the same headings, so update the headers in this document to match the target locale. Replace the untranslated headings for Discovery, Generation, Jobs and batches, Saved workflows, Apps and links, and Account and session with the appropriate localized equivalents, keeping the rest of the content unchanged and ensuring the translation hashes still reflect the synchronized text.
🤖 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`:
- Line 57: The newly added MDX content uses em dashes in several descriptions,
which violates the documentation style guideline. Update the affected entries in
the table and prose by replacing each em dash with a period, comma, colon,
parentheses, or a second sentence, and verify the wording in run_template,
submit_batch, run_saved_workflow, create_app, report_session_summary, and the
“you agreed to spend credits” sentence all follow the same style.
In `@ko/agent-tools/cloud.mdx`:
- Line 70: The affected glossary rows in cloud.mdx are still using the copied
English em dash punctuation, so update the descriptions for run_template,
submit_batch, create_app, and report_session_summary to use Korean-appropriate
punctuation and sentence structure instead of the raw “—” character. Keep the
meaning the same, but rewrite each entry in a natural Korean style consistent
with the other localized docs, similar to how ja/zh handled these items.
---
Outside diff comments:
In `@ko/agent-tools/cloud.mdx`:
- Line 53: The section headers in cloud.mdx are still in English while the
localized ja/zh versions translate the same headings, so update the headers in
this document to match the target locale. Replace the untranslated headings for
Discovery, Generation, Jobs and batches, Saved workflows, Apps and links, and
Account and session with the appropriate localized equivalents, keeping the rest
of the content unchanged and ensuring the translation hashes still reflect the
synchronized text.
🪄 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: f54397ac-b215-43a7-af10-6f5c06cb0264
📒 Files selected for processing (4)
agent-tools/cloud.mdxja/agent-tools/cloud.mdxko/agent-tools/cloud.mdxzh/agent-tools/cloud.mdx
|
|
||
| | Tool | Description | | ||
| | --- | --- | | ||
| | `run_template` | Run a pre-built template by name, with optional parameter overrides — the preferred path when a template matches | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Em dashes in new content violate the MDX style guideline.
Several newly-added rows/sentences use em dashes (—) where the guideline asks for periods, commas, colons, parentheses, or a second sentence:
- Line 57:
run_templatedescription - Line 73:
submit_batch, ...description - Line 83:
run_saved_workflowdescription - Line 98:
create_appdescription - Line 109:
report_session_summarydescription - Line 115: "...you agreed to spend credits — so expect the agent..."
✏️ Proposed fixes
-| `run_template` | Run a pre-built template by name, with optional parameter overrides — the preferred path when a template matches |
+| `run_template` | Run a pre-built template by name, with optional parameter overrides. Preferred path when a template matches. |-| `submit_batch`, `get_batch_status`, `get_batch_output`, `wait_for_batch` | Submit many generations in one call and collect them together later — the batch ID stays valid across sessions |
+| `submit_batch`, `get_batch_status`, `get_batch_output`, `wait_for_batch` | Submit many generations in one call and collect them together later (the batch ID stays valid across sessions) |-| `run_saved_workflow` | Run a saved workflow by filename — the server converts it from editor format to executable format automatically |
+| `run_saved_workflow` | Run a saved workflow by filename. The server converts it from editor format to executable format automatically. |-| `create_app` | Turn a saved workflow into an App Mode app — a simplified "run this workflow" view with chosen inputs and outputs |
+| `create_app` | Turn a saved workflow into an App Mode app: a simplified "run this workflow" view with chosen inputs and outputs |-| `report_session_summary` | Share an anonymized session summary with the Comfy team — **only with your explicit consent**; the agent must ask first, and no prompts, file paths, or personal information are included |
+| `report_session_summary` | Share an anonymized session summary with the Comfy team, **only with your explicit consent**. The agent must ask first, and no prompts, file paths, or personal information are included |-...the server blocks execution until your agent confirms you agreed to spend credits — so expect the agent to check with you before those runs.
+...the server blocks execution until your agent confirms you agreed to spend credits. Expect the agent to check with you before those runs.As per coding guidelines, "In English documentation, avoid em dashes (—); use periods, commas, colons, parentheses, or a second sentence instead."
Also applies to: 73-73, 83-83, 98-98, 109-109, 115-115
🤖 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` at line 57, The newly added MDX content uses em dashes
in several descriptions, which violates the documentation style guideline.
Update the affected entries in the table and prose by replacing each em dash
with a period, comma, colon, parentheses, or a second sentence, and verify the
wording in run_template, submit_batch, run_saved_workflow, create_app,
report_session_summary, and the “you agreed to spend credits” sentence all
follow the same style.
Source: Coding guidelines
|
|
||
| | 도구 | 설명 | | ||
| | --- | --- | | ||
| | `run_template` | 사전 구축된 템플릿을 이름으로 실행(선택적 매개변수 재정의 가능) — 일치하는 템플릿이 있을 때 선호되는 경로 | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value
Literal em dashes copied over from the English source.
Rows such as run_template (70), submit_batch... (73), create_app (111), and report_session_summary (122) keep the raw "—" character straight from the English text, whereas ja rewrote these as separate sentences and zh used the conventional Chinese double dash "——". Worth adapting to a punctuation style more natural for Korean docs, and it would also sidestep the underlying em-dash guideline issue once fixed upstream in the English source.
Also applies to: 73-73, 86-86, 111-111, 122-122
🤖 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 70, The affected glossary rows in cloud.mdx
are still using the copied English em dash punctuation, so update the
descriptions for run_template, submit_batch, create_app, and
report_session_summary to use Korean-appropriate punctuation and sentence
structure instead of the raw “—” character. Keep the meaning the same, but
rewrite each entry in a natural Korean style consistent with the other localized
docs, similar to how ja/zh handled these items.
2 participants
What
Brings docs.comfy.org/agent-tools/cloud up to date with the MCP server as deployed (v0.28.1). The page documented 16 tools; the server registers 37.
English page (
agent-tools/cloud.mdx)run_saved_workflowhandles fetch → convert → submit by filename now; Known limitations rewritten around the real remaining gap (conversion edge cases)run_template) andpartner_generatefor partner models (Flux, Grok, Gemini, OpenAI, Ideogram, Seedance)report_session_summarydocumented explicitlyTranslations (ko / zh / ja)
translationSourceHash/translationBlockHashesre-stamped using the repo's ownchunked-translate.tshelpers —getSectionSyncStatusreports up-to-date, no pending blocks for all three, so the auto-translate pipeline won't re-translate over the hand-synced contentVerification
comfy-cloud-mcp-server/src/tools.tsat v0.28.1) appear in each of the 4 files🤖 Generated with Claude Code