docs: add OpenAI Codex MCP onboarding#16
Merged
marmar9615-cloud merged 1 commit intomainfrom Apr 28, 2026
Merged
Conversation
AgentBridge already worked with OpenAI Codex at the protocol level because the bundled MCP server speaks stdio and Codex can launch any stdio MCP server. This change closes the onboarding gap with a dedicated Codex setup doc, copy-pasteable config.toml snippets, an AGENTS.md for any AI coding agent looking at the repo, an experimental local plugin skeleton, and an updated mcp-config CLI command that emits Codex configs alongside the existing ones. No protocol behavior, schema, or safety invariant changes. The MCP server exposes the same five tools, four resources, four prompts, and the same confirmation token / origin pinning / loopback-only / audit redaction guarantees as v0.2.1. All 86 existing tests still pass; new mcp-config test brings the suite to 87. What's new Docs: - docs/codex-setup.md — full Codex onboarding walkthrough (CLI add, global config.toml, project-scoped config.toml, demo pairing, troubleshooting, safety reminders). - docs/mcp-client-setup.md restructured to be client-neutral with sections for Codex, Claude Desktop, Cursor, custom; new "Safety expectations for all clients" section. - AGENTS.md (root) — model-neutral working notes for any AI coding agent. Sibling to the deeper Claude-Code-focused CLAUDE.md. - README.md gained a "Works with MCP clients" subsection, Codex one-liner, Cursor JSON, AGENTS.md row. Examples: - examples/codex-config/ — config.global.toml, config.project.toml plus a README explaining when to use which. - examples/codex-plugin/ — experimental local Codex plugin skeleton (.codex-plugin/plugin.json, .mcp.json, skills/agentbridge/SKILL.md). Not a published plugin; supported flow remains docs/codex-setup.md. - examples/mcp-client-config/README.md gained Codex section; standardized JSON snippets on `npx -y` so first-run installs don't prompt. CLI: - agentbridge mcp-config now prints Codex CLI / Codex config.toml / Claude Desktop / Cursor / raw stdio / local checkout snippets plus a safety reminder. New CLI test asserts each block is present. Per-package READMEs: - mcp-server and cli READMEs got new Codex setup sections. - core / sdk / scanner / openapi Status blocks updated to describe v0.2.2 as the Codex-onboarding release. Versions: - All 9 workspace package.json files bumped 0.2.1 → 0.2.2 (six publishable packages plus root and the two private apps). package-lock.json refreshed. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
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
AgentBridge already worked with OpenAI Codex at the protocol level
because the bundled MCP server speaks stdio and Codex can launch
any stdio MCP server. This PR closes the onboarding gap:
docs/codex-setup.md)config.tomlsnippets (global + project-scoped)AGENTS.mdsibling to the existingCLAUDE.mdagentbridge mcp-configCLI command that emits Codexconfigs alongside the existing Claude Desktop / Cursor snippets
README don't read as "Claude Desktop only"
No protocol, schema, or safety-behavior changes. Same five MCP
tools, four resources, four prompts, same confirmation tokens, same
origin pinning, same loopback-only default, same audit redaction,
same simulated destructive demo actions.
What changed
Docs (new + refactored)
docs/codex-setup.md— three setup options (CLIcodex mcp add, global~/.codex/config.toml, project-scoped.codex/config.toml), demo-app pairing, prompt suggestions,troubleshooting, safety reminders.
docs/mcp-client-setup.mdrestructured to be client-neutralwith sections for OpenAI Codex, Claude Desktop, Cursor, and custom
MCP clients, plus a "Safety expectations for all clients" block.
AGENTS.md(root) — short, model-neutral working notes for anyAI coding agent (Codex, Claude, Cursor, custom). Sibling to the
deeper Claude-Code-focused
CLAUDE.md.README.mdgained a "Works with MCP clients" subsection, Codexone-liner, Cursor JSON, AGENTS.md row in the docs table.
Examples (new)
examples/codex-config/—config.global.toml,config.project.toml, README explaining when to use which.examples/codex-plugin/— experimental local Codex pluginskeleton with
.codex-plugin/plugin.json,.mcp.json, andskills/agentbridge/SKILL.md. Not a published plugin — thesupported flow stays
docs/codex-setup.md.examples/mcp-client-config/README gained a Codex section;JSON snippets standardized on
npx -y.CLI
agentbridge mcp-confignow prints these blocks in order: rawstdio, OpenAI Codex CLI, OpenAI Codex
config.toml, ClaudeDesktop, Cursor / generic JSON, local checkout, safety reminder.
packages/cli/src/tests/cli.test.tsasserts eachblock is present in the output.
Per-package READMEs
@marmarlabs/agentbridge-mcp-serverand@marmarlabs/agentbridge-cliREADMEs got new Codex setupsections.
core,sdk,scanner,openapi) updated their Status blocks to describe v0.2.2 as theCodex-onboarding release for consistency.
Versions
package.jsonfiles bumped 0.2.1 → 0.2.2 (sixpublishable packages plus root and the two private apps).
package-lock.jsonrefreshed.CHANGELOG.mdentry anddocs/releases/v0.2.2.mdrelease notesadded.
Workspace dependency ranges remain
^0.2.0—0.2.2satisfies therange, no consumer migration required.
What did NOT change
apps/mcp-server/src/{tools,safety,confirmations, idempotency}.tswere touched.Local checks
npm cinpm run typecheck:cleannpm test— 87 passed (was 86 before; new mcp-config test)npm run buildnpm run pack:dry-run— all 6 tarballs validated at 0.2.2npm run smoke:external— PASS(cd apps/demo-app && npx next build)— passed(cd apps/studio && npx next build)— passednode packages/cli/dist/bin.js version→0.2.2node packages/cli/dist/bin.js mcp-config— Codex CLI + Codexconfig.toml + Claude Desktop + Cursor + raw stdio + local checkout
node packages/cli/dist/bin.js validate ...→ ✓ valid manifestnode packages/cli/dist/bin.js generate openapi ...→ 4 actionsnode apps/mcp-server/dist/index.js < /dev/null→ exits cleanlyCodex setup commands users will see
# CLI one-liner codex mcp add agentbridge -- npx -y @marmarlabs/agentbridge-mcp-serverTest plan
release-checkworkflow passes after merge to mainnpm view @marmarlabs/agentbridge-{...} versionreturns0.2.2andnpm view ... readmeshows the new Codex sections🤖 Generated with Claude Code