docs(cua-driver): MCP client wire-up pages (Codex / Cursor / Hermes / OpenClaw / OpenCode)#1585
Open
f-trycua wants to merge 1 commit into
Open
docs(cua-driver): MCP client wire-up pages (Codex / Cursor / Hermes / OpenClaw / OpenCode)#1585f-trycua wants to merge 1 commit into
f-trycua wants to merge 1 commit into
Conversation
… OpenClaw / OpenCode) Add a new `guide/integrations/` section anchored by `mcp-clients.mdx` — one index page covering every client `cua-driver mcp-config --client <name>` supports (Claude Code, Codex, Cursor, Hermes, OpenClaw, OpenCode, plus the Pi non-MCP fallback). Each section quotes the CLI's output verbatim so the docs stay diffable against `cli.rs::run_mcp_config`, lists the config-file path the registration lands in, gives a manual snippet for users who prefer hand- editing, shows how to verify, and cross-links the macOS TCC and Windows SSH / daemon-proxy gotchas. Closes CUA-539
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📝 WalkthroughWalkthroughThis PR adds a comprehensive MCP client registration guide documenting how to configure ChangesMCP Client Integration Guide
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/content/docs/cua-driver/guide/integrations/mcp-clients.mdx (1)
275-275: ⚡ Quick winClarify the relationship between new and legacy integrations pages.
The sentence "this page replaces it as the canonical entry point and will keep that one as deep-link target" is potentially confusing. Consider rephrasing to clarify:
- This page is now the primary/canonical integrations documentation
- The legacy page remains available for specific deep-link references to vision-model and computer-use content
📝 Suggested rephrasing
-- [Integrations (legacy reference)](/cua-driver/guide/getting-started/integrations) — original per-client reference page; this page replaces it as the canonical entry point and will keep that one as deep-link target for vision-model and computer-use specifics. +- [Integrations (legacy reference)](/cua-driver/guide/getting-started/integrations) — original per-client reference page. This new page is now the canonical integrations entry point; the legacy page remains available for deep-link references to vision-model and computer-use specifics.🤖 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 `@docs/content/docs/cua-driver/guide/integrations/mcp-clients.mdx` at line 275, Rewrite the confusing sentence that begins "[Integrations (legacy reference)](/cua-driver/guide/getting-started/integrations) — original per-client reference page; this page replaces it as the canonical entry point and will keep that one as deep-link target" to clearly state that the current page is now the primary/canonical integrations documentation while the legacy page remains available solely for deep-links to vision-model and computer-use specific content; update the phrasing to something like "This page is now the canonical integrations guide; the legacy per-client page is preserved only for deep links to vision-model and computer-use specifics."
🤖 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.
Nitpick comments:
In `@docs/content/docs/cua-driver/guide/integrations/mcp-clients.mdx`:
- Line 275: Rewrite the confusing sentence that begins "[Integrations (legacy
reference)](/cua-driver/guide/getting-started/integrations) — original
per-client reference page; this page replaces it as the canonical entry point
and will keep that one as deep-link target" to clearly state that the current
page is now the primary/canonical integrations documentation while the legacy
page remains available solely for deep-links to vision-model and computer-use
specific content; update the phrasing to something like "This page is now the
canonical integrations guide; the legacy per-client page is preserved only for
deep links to vision-model and computer-use specifics."
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ca9c690c-7285-448a-90a2-7be5ff07b59e
📒 Files selected for processing (3)
docs/content/docs/cua-driver/guide/integrations/mcp-clients.mdxdocs/content/docs/cua-driver/guide/integrations/meta.jsondocs/content/docs/cua-driver/guide/meta.json
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new
docs/content/docs/cua-driver/guide/integrations/section anchored bymcp-clients.mdx— one index page covering every MCP client thatcua-driver mcp-config --client <name>knows how to register. Wires the new subdir into the guide sidebar viameta.json.Source of truth for what each client section says is
libs/cua-driver-rs/crates/cua-driver/src/cli.rs::run_mcp_config— the CLI's output is quoted verbatim per client so the docs stay diffable against the CLI when it changes.Per-client coverage
The CLI's
run_mcp_configsupports 7 client arg values today:claude,codex,cursor,openclaw,opencode,hermes,pi. All 7 are documented:installation.mdxwrite-up (TCC auto-delegation, computer-use compat mode). No duplication.codex mcp addone-liner +~/.codex/config.tomlmanual snippet + verify.mcp-config --client cursorJSON output verbatim +~/.cursor/mcp.jsonpaste location + verify in Cursor settings.~/.hermes/config.yamlpaste location +/reload-mcpactivation.openclaw mcp setshell command verbatim + verify.opencode.json/ global paste locations + verify. Warns about silent screenshot drop on CLI fallback path.Per-platform notes wired in
installation.mdx#grant-tcc-permissionsand the TCC auto-delegation callout.windows-ssh.mdx(PR docs(cua-driver): Windows SSH workflow + autostart concept page #1583) for the Session 0 / daemon-proxy story.cua-driver serve &+ autostart pointer.CLI source-of-truth
Every per-client snippet is quoted verbatim from
run_mcp_config(cli.rs:544-619). If the CLI output ever changes, this page is updated by diffing against the new CLI output — no paraphrasing to reconcile.Discrepancies / scope decisions
~/.config/codex/mcp.jsonlocation but doesn't warrant its own page.run_mcp_confighas apibranch with explicit guidance — included verbatim per the "include any output you haven't described" instruction. Pi is documented as "not MCP" so users searching for it land on the right answer.getting-started/integrations.mdxbut not inrun_mcp_config. Skipped on the new page since the CLI doesn't auto-generate config for them. The legacy page stays as-is and is cross-linked from the new page's "See also".installation.mdx— avoids duplicating the existing TCC + computer-use-compat sections.Total diff size
3 files, +285 / -1 lines:
docs/content/docs/cua-driver/guide/integrations/mcp-clients.mdx(new, 277 lines)docs/content/docs/cua-driver/guide/integrations/meta.json(new, sidebar registration)docs/content/docs/cua-driver/guide/meta.json(1 line, registersintegrationsas a sibling ofgetting-started)Test plan
pnpm devindocs/renders/cua-driver/guide/integrations/mcp-clientswithout MDX compile errors.#claude-code,#openclaw) resolve.installation.mdx,windows-ssh.mdx,integrations.mdx,autostart.mdxresolve.cua-driver mcp-config --client <name>byte-for-byte.Closes CUA-539
Summary by CodeRabbit
Documentation