docs(agent-tools): add Comfy Local MCP as the first-party local option#1236
Conversation
mattmillerai
added
cursor-review
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
📝 WalkthroughWalkthroughThis PR introduces "Comfy Local MCP," a first-party local MCP server documented across English, Japanese, Korean, and Chinese. Overview pages gain a new comparison card/column, docs.json adds navigation entries for the new local.mdx pages, and community MCP server framing is revised in each locale. ChangesComfy Local MCP Documentation
Sequence Diagram(s)sequenceDiagram
participant Client as MCP Client
participant Server as comfy-local-mcp
participant CLI as comfy-cli
participant ComfyUI
Client->>Server: server_info
Server->>CLI: comfy --where local status
CLI->>ComfyUI: query status
ComfyUI-->>Server: status result
Client->>Server: run_workflow
Server->>CLI: comfy --where local run
CLI->>ComfyUI: execute workflow
Client->>Server: fetch_outputs
Server-->>Client: output files
No gremlins here, just docs galore, 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
🌐 i18n translation sync reminder@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files: Japanese (
|
…inese documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/local.mdx`:
- Line 52: The Claude MCP add example is using the wrong argument order, so
update the command in the local setup docs to place the environment flag before
the server name. Fix the `claude mcp add` example under the comfy-local entry so
`-e COMFY_BIN=/path/to/venv/bin/comfy` appears before `comfy-local`, matching
the supported parsing order for Claude Code versions.
🪄 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: f8b1c56a-16a7-42b5-bedf-ad6f9de47b58
📒 Files selected for processing (9)
agent-tools/index.mdxagent-tools/local.mdxdocs.jsonja/agent-tools/index.mdxja/agent-tools/local.mdxko/agent-tools/index.mdxko/agent-tools/local.mdxzh/agent-tools/index.mdxzh/agent-tools/local.mdx
| One command registers the server: | ||
|
|
||
| ```bash | ||
| claude mcp add comfy-local -e COMFY_BIN=/path/to/venv/bin/comfy -- comfy-local-mcp |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🌐 Web query:
Does claude mcp add -e KEY=VALUE -- (env flag after the server name) work correctly in the current Claude Code CLI, or is env flag placement before the name required?
💡 Result:
In the current Claude Code CLI, the environment variable flag must be placed before the server name. Placing the env flag after the server name is not supported and will cause the command to fail or be parsed incorrectly [1][2][3]. According to official documentation and technical discussions, all configuration options—including --env (or -e), --transport, and --scope—must precede the server name [1][2][3]. The -- separator is then used to delineate the end of these configuration flags and the start of the command that launches the server [4][5]. A known issue in the CLI exists where the parser may greedily consume the server name as part of the env-var value if the syntax is not strictly followed [6]. To ensure the command is parsed as intended, you should use the following order: claude mcp add [OPTIONS] -- [args...] For example: claude mcp add --env KEY=VALUE --transport stdio -- Documentation explicitly advises placing at least one other option (such as --transport) between the --env flag and the server name if you encounter parsing difficulties, as this helps prevent the CLI from incorrectly treating the server name as an additional environment variable pair [4][5].
Citations:
- 1: [DOCS] Contradictory Syntax Requirements for
claude mcp addbetween Documentation Text and Interactive Code Generator anthropics/claude-code#19120 - 2: https://claude-code-guide.org/mcp/
- 3: [DOCS] CLI Syntax Inconsistency regarding
--separator forclaude mcp addanthropics/claude-code#18722 - 4: https://code.claude.com/docs/en/mcp.md
- 5: https://claude-code.mintlify.app/en/mcp
- 6: [BUG] claude mcp add -e <KEY=VAL> <name> -- <cmd> still fails in 2.1.150 (the syntax printed by --help) anthropics/claude-code#62332
Move -e before the server name
claude mcp add comfy-local -e COMFY_BIN=/path/to/venv/bin/comfy -- comfy-local-mcp is parsed incorrectly on supported Claude Code versions. Use claude mcp add -e COMFY_BIN=/path/to/venv/bin/comfy comfy-local -- comfy-local-mcp instead. Tiny typo, big nope.
🤖 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/local.mdx` at line 52, The Claude MCP add example is using the
wrong argument order, so update the command in the local setup docs to place the
environment flag before the server name. Fix the `claude mcp add` example under
the comfy-local entry so `-e COMFY_BIN=/path/to/venv/bin/comfy` appears before
`comfy-local`, matching the supported parsing order for Claude Code versions.
2 participants
ELI-5
Our agent-tools page tells people how to connect AI agents (Claude Code, Claude Desktop, Cursor) to ComfyUI. Until now it listed our hosted Cloud MCP, the Partner MCP, and the CLI — and for driving a local ComfyUI it pointed only at community projects. This adds Comfy Local MCP (
comfy-local-mcp), our own first-party server for driving the ComfyUI on your own machine, so local users have an official option front-and-center.What changed
agent-tools/local.mdx— "Comfy Local MCP": requirements, install, and client config (Claude Code / Claude Desktop / Cursor), a quickstart, and a tools overview. Sourced from the project README.agent-tools/index.mdxdocs.json— registeredagent-tools/localin the Agent Tools nav.Notes for the reviewer (judgment calls)
Comfy-Org/comfy-local-mcpis currently private. The new page and the repo/install links assume it is public; make the repo public before merging, or the GitHub links (and thepip install .from a checkout) will 404 for readers. The page carries an "Early preview" warning to match the tool's POC status (same treatment as the Partner MCP preview page).translationSourceHash+npm run translate); the sync check is a non-blocking reminder. English source is updated here; the pipeline / @comfyui-wiki should regenerate the localeagent-tools/indexpages, the newlocalpage, and the locale nav entries.Verification
mint broken-links— passes (no broken links, MDX parses).