Skip to content

docs(messaging): document Claude Code MCP setup and reply checks - #8949

Merged
lidge-jun merged 1 commit into
lidge-jun:devfrom
HojooonKim:codex/docs-mcp-client-setup
Nov 21, 2026
Merged

lidge-jun merged 1 commit into
lidge-jun:devfrom
HojooonKim:codex/docs-mcp-client-setup

Conversation

@HojooonKim

@HojooonKim HojooonKim commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The messaging reference shows an MCP server entry but leaves readers to figure out where to put it and how to tell whether Codex answered. Document workspace-scoped registration for the Claude Code CLI and the local Code tab in Claude Desktop. Walk through opening an idle Codex test conversation, submitting one message, and using the same receipt to check the final reply without re-sending on timeout or an uncertain result.

Link the Spanish and Turkish references to the walkthrough. The Desktop Chat surface uses separate configuration; this walkthrough covers the CLI and Code tab. Documentation only; the existing tool and permission behavior is unchanged. Follow-up to #7999, #8053, and #8090.

Verification

  • Current head 25c14a68f rebased onto upstream dev d61cca122. The three-file docs patch is unchanged (git range-diff). Revalidated on macOS with Bun 1.4.4.
  • cd docs-site && bun install --frozen-lockfile && bun run build: passed, 820 pages and 126,235 internal links checked.
  • bun test tests/cli/cli-message-mcp.test.ts tests/codex-integration/messaging-mcp-wait.test.ts: 29 passed, 0 failed. bun run typecheck (2,681 files), bun run privacy:scan, bun run structure:check, and git diff --check origin/dev...HEAD passed.
  • Installed the published OpenCodex 2.100.5 package in a scratch directory. ocx help message mcp showed the documented flags; the documented claude mcp add --scope local invocation followed by claude mcp get opencodex-queue returned Connected in a temporary Claude config. Direct stdio MCP tools/list returned exactly two default tools and four with --allow-reply-read.
  • Previously ran the actual Claude Code 2.1.317 CLI and Claude Desktop 5.11492.5 Code tab round trips against merged dev c320932c1 with Codex CLI 0.166.0 and disposable homes. Each sent once, used the same receipt, and observed the expected stored final answer. The Desktop Chat surface was outside those runs.
  • Repeated the full CLI round trip with published OpenCodex 2.100.5, Claude Code 2.1.328 and the documented local registration in temporary config. The CLI found the exact idle test thread, queued once, received the expected text through codex_wait_reply using the same receipt, and the Codex history contained the correlated input and final text in one completed turn. Desktop Code was verified on merged dev as noted above.
  • The full local suite was omitted for the documentation-only diff. The site build, direct client registration, and focused MCP regressions cover the changed instructions; PR gates passed and CodeRabbit reported no actionable findings on 25c14a68f. The fork-triggered GitHub CI run returned action_required before any job ran; hosted test results are still pending maintainer approval.

Checklist

  • Scope stays focused and avoids unrelated cleanup.
  • Docs or release notes were updated when needed.
  • Security-sensitive changes were reviewed for secrets, auth, and unsafe defaults. The example uses placeholder paths and documents the existing reply-read opt-in.

Review readiness checklist

  • Required local validation passed; commands, results, and any full-suite exception are documented.
  • I pushed my PR to a recent dev commit (at most 10 behind; a maintainer may still ask for the exact tip before merge).
  • I resolved all correct Codex and CodeRabbit findings.
  • My PR is ready for review.

Summary by CodeRabbit

  • Documentation
    • Expanded the MCP queue-host setup guidance for Claude Code and Claude Desktop’s Code tab.
    • Added instructions for enabling reply reading and verifying a message round trip.
    • Clarified that a queued receipt does not confirm processing, and advised against resending after an unknown submission or wait timeout.
    • Updated the Spanish and Turkish documentation with client setup references.

@coderabbitai

coderabbitai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The MCP queue documentation now identifies Claude Code CLI and Claude Desktop’s Code tab as example clients. The English guide adds setup and reply-check instructions. The Spanish and Turkish guides add client references and configuration links.

Changes: MCP queue client documentation

Layer / File(s) Summary
Client setup and reply checks
docs-site/src/content/docs/reference/cli/messaging.md, docs-site/src/content/docs/es/reference/cli/messaging.md, docs-site/src/content/docs/tr/reference/cli/messaging.md
The English guide explains local client setup, enabling reply reading, queuing a message, and checking its receipt. It distinguishes queue acknowledgement from processing and warns against resending after an unknown submission or wait timeout. The Spanish and Turkish guides name the clients and link to setup and reply-verification instructions.

Estimated code review effort: 1 (Trivial) | ~8 minutes

Change: Other

Possibly related PRs

Suggested reviewers: lidge-jun, ingwannu

Merge Risk: Minimal · up to 25c14

This is a documentation-only change that adds Claude Code setup and reply-check instructions. No behavior changes, and no merge-blocking risk was found.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "docs(messaging): document Claude Code MCP setup and reply checks" matches the changeset. The raw summary shows edits to the English, Spanish, and Turkish messaging.md reference pages. These…
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.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Title check

Explanation

The title "docs(messaging): document Claude Code MCP setup and reply checks" matches the changeset. The raw summary shows edits to the English, Spanish, and Turkish messaging.md reference pages. These edits add Claude Code CLI and Claude Desktop Code-tab MCP setup, reply-reading enablement, and reply round-trip checks. The title names the main change and the docs scope, so it passes.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between d61cca1 and 25c14a6.

Files selected for processing: 3

  • docs-site/src/content/docs/es/reference/cli/messaging.md
  • docs-site/src/content/docs/reference/cli/messaging.md
  • docs-site/src/content/docs/tr/reference/cli/messaging.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

@github-actions

Copy link
Copy Markdown
Contributor

✅ Deterministic PR hygiene checks passed.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 19, 2026
@github-actions

github-actions Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

✅ READY

  • all PR quality gates passed; the review readiness checklist is complete.

Review readiness checklist

  • ✅ Required local validation passed; commands, results, and any full-suite exception are documented.
  • ✅ I pushed my PR to a recent dev commit (at most 10 behind; a maintainer may still ask for the exact tip before merge).
  • ✅ I resolved all correct Codex and CodeRabbit findings.
  • ✅ My PR is ready for review.

✅ 4/4 boxes ticked.

This pull request has been marked Ready for Review.
The review-ready label marks this PR as ready; review automation runs independently.
Maintainers notified: @lidge-jun @Ingwannu

Hygiene

✅ Deterministic PR hygiene checks passed.

@HojooonKim
HojooonKim force-pushed the codex/docs-mcp-client-setup branch from eee57c7 to 25c14a6 Compare November 20, 2026 08:10

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@github-actions
github-actions Bot marked this pull request as ready for review November 20, 2026 08:24
@lidge-jun

Copy link
Copy Markdown
Owner

Maintainer integration into dev (MAINTAINERS.md maintainer-integration exception; lane fb2101-queue-b).

  • Exact head: 25c14a68f73510524b8f6df2f3bff1f697411775
  • Checks on this head: all completed checks pass (ci aggregate, gates/test changed where selected, CodeRabbit, enforce-target, hygiene); none pending or failing.
  • Review: terra review APPROVE, no actionable findings; docs-only (en/es/tr messaging reference).
  • Review threads: 0 unresolved.
  • Scope: docs-only; no auth, workflow, release, dependency or provider-preset surface.

This is maintainer integration, not an independent approval.

@lidge-jun
lidge-jun merged commit 4082100 into lidge-jun:dev Nov 21, 2026
39 checks passed
lidge-jun added a commit that referenced this pull request Nov 21, 2026
Restore parity with #8949: the Spanish messaging reference carries the same
claude mcp add example and external link as English, so the Spanish
localization test passes again.
lidge-jun added a commit that referenced this pull request Nov 21, 2026
…#9028)

* docs(structure): keep error-detail.md within its line budget

Join the sentence added by #8980 onto the preceding line of its paragraph;
the rendered text is unchanged and the doc returns to 600 lines.

* docs(es): translate the Claude Code MCP round-trip section

Restore parity with #8949: the Spanish messaging reference carries the same
claude mcp add example and external link as English, so the Spanish
localization test passes again.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation review-ready

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants