Skip to content

docs: add OpenAI Codex MCP onboarding#16

Merged
marmar9615-cloud merged 1 commit intomainfrom
feature/codex-openai-onboarding
Apr 28, 2026
Merged

docs: add OpenAI Codex MCP onboarding#16
marmar9615-cloud merged 1 commit intomainfrom
feature/codex-openai-onboarding

Conversation

@marmar9615-cloud
Copy link
Copy Markdown
Owner

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:

  • A dedicated Codex setup doc (docs/codex-setup.md)
  • Copy-pasteable config.toml snippets (global + project-scoped)
  • A model-neutral AGENTS.md sibling to the existing
    CLAUDE.md
  • An experimental local Codex plugin skeleton
  • An updated agentbridge mcp-config CLI command that emits Codex
    configs alongside the existing Claude Desktop / Cursor snippets
  • Per-package and root README updates so the npm pages and the public
    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 (CLI codex mcp add, global ~/.codex/config.toml, project-scoped
    .codex/config.toml), demo-app pairing, prompt suggestions,
    troubleshooting, safety reminders.
  • docs/mcp-client-setup.md restructured to be client-neutral
    with 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 any
    AI coding agent (Codex, Claude, Cursor, custom). 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 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 plugin
    skeleton with .codex-plugin/plugin.json, .mcp.json, and
    skills/agentbridge/SKILL.md. Not a published plugin — the
    supported flow stays docs/codex-setup.md.
  • examples/mcp-client-config/ README gained a Codex section;
    JSON snippets standardized on npx -y.

CLI

  • agentbridge mcp-config now prints these blocks in order: raw
    stdio, OpenAI Codex CLI, OpenAI Codex config.toml, Claude
    Desktop, Cursor / generic JSON, local checkout, safety reminder.
  • New CLI test in packages/cli/src/tests/cli.test.ts asserts each
    block is present in the output.

Per-package READMEs

  • @marmarlabs/agentbridge-mcp-server and
    @marmarlabs/agentbridge-cli READMEs got new Codex setup
    sections.
  • The other four publishable READMEs (core, sdk, scanner,
    openapi) updated their Status blocks to describe v0.2.2 as the
    Codex-onboarding release for consistency.

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.
  • CHANGELOG.md entry and docs/releases/v0.2.2.md release notes
    added.

Workspace dependency ranges remain ^0.2.00.2.2 satisfies the
range, no consumer migration required.

What did NOT change

Local checks

  • npm ci
  • npm run typecheck:clean
  • npm test87 passed (was 86 before; new mcp-config test)
  • npm run build
  • npm run pack:dry-run — all 6 tarballs validated at 0.2.2
  • npm run smoke:external — PASS
  • (cd apps/demo-app && npx next build) — passed
  • (cd apps/studio && npx next build) — passed
  • node packages/cli/dist/bin.js version0.2.2
  • node packages/cli/dist/bin.js mcp-config — Codex CLI + Codex
    config.toml + Claude Desktop + Cursor + raw stdio + local checkout
    • safety reminder all printed
  • node packages/cli/dist/bin.js validate ... → ✓ valid manifest
  • node packages/cli/dist/bin.js generate openapi ... → 4 actions
  • node apps/mcp-server/dist/index.js < /dev/null → exits cleanly

Codex setup commands users will see

# CLI one-liner
codex mcp add agentbridge -- npx -y @marmarlabs/agentbridge-mcp-server
# ~/.codex/config.toml or .codex/config.toml
[mcp_servers.agentbridge]
command = "npx"
args = ["-y", "@marmarlabs/agentbridge-mcp-server"]
startup_timeout_sec = 20
tool_timeout_sec = 60
enabled = true

Test plan

  • CI passes on Node 20.x and 22.x
  • Manual release-check workflow passes after merge to main
  • After publish (separate manual step, not in this PR): npm view @marmarlabs/agentbridge-{...} version returns 0.2.2 and npm view ... readme shows the new Codex sections

🤖 Generated with Claude Code

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>
@marmar9615-cloud marmar9615-cloud merged commit 1034357 into main Apr 28, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant