From 6c96f0c671ab66a6ec5a6d85579fe683c2e4ff07 Mon Sep 17 00:00:00 2001 From: Sai Prakash Date: Fri, 17 Jul 2026 00:29:24 -0400 Subject: [PATCH] Add MCP connect snippets for Codex, Copilot, and Antigravity MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The MCP server itself needed no changes — all three speak Streamable HTTP with a bearer-token Authorization header against the same /api/mcp/mcp endpoint, same as Claude Code and Cursor already did. Adds matching config tabs, README instructions, and doc updates. Co-Authored-By: Claude Sonnet 5 --- README.md | 35 ++++++++++++++- app/(dashboard)/settings/api-keys-panel.tsx | 48 ++++++++++++++++++++- docs/index.html | 2 +- docs/specs/mcp-server-spec.md | 8 ++++ 4 files changed, 88 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0be91e8..d2236b0 100644 --- a/README.md +++ b/README.md @@ -322,9 +322,9 @@ Specs live in git (`docs/specs/*.md` by convention), not in CodePlans. Link a sp --- -## Connect Claude Code or Cursor (MCP) +## Connect an AI coding agent (MCP) -CodePlans ships an MCP server at `/api/mcp/mcp` (Streamable HTTP). Create an API key in **Settings → API Keys** — the settings page shows these snippets with your host and freshly minted key pre-filled. +CodePlans ships an MCP server at `/api/mcp/mcp` (Streamable HTTP, bearer-token auth). Create an API key in **Settings → API Keys** — the settings page shows these snippets with your host and freshly minted key pre-filled, for Claude Code, Cursor, Codex, GitHub Copilot, and Antigravity. **Claude Code** (user scope — available in every project): @@ -346,6 +346,37 @@ claude mcp add --scope user --transport http codeplans http://localhost:3000/api } ``` +**Codex CLI** — reads the bearer token from an environment variable rather than storing it in `~/.codex/config.toml` directly: + +```bash +export CODEPLANS_API_KEY="cpk_your_key" +codex mcp add codeplans \ + --url http://localhost:3000/api/mcp/mcp \ + --bearer-token-env-var CODEPLANS_API_KEY +``` + +**GitHub Copilot CLI**: + +```bash +copilot mcp add --transport http codeplans http://localhost:3000/api/mcp/mcp \ + --header "Authorization: Bearer cpk_your_key" +``` + +In VS Code's Copilot Chat instead, add the same URL/header under a `"servers"` entry in `.vscode/mcp.json` with `"type": "http"`. + +**Antigravity** — add to `~/.gemini/config/mcp_config.json` (note the field is `serverUrl`, not `url`), then reload MCP servers from the agent panel: + +```json +{ + "mcpServers": { + "codeplans": { + "serverUrl": "http://localhost:3000/api/mcp/mcp", + "headers": { "Authorization": "Bearer cpk_your_key" } + } + } +} +``` + Your agent can then read plans/work items/tech debt and (with a write-scope key) model products, assets, and dependencies, manage plans end-to-end (create, target assets, activate/complete), file work items, manage tasks, and record branch/PR status on plan assets. Keys act as your user, so org access rules and mirrored-field protections apply unchanged. See [`docs/specs/mcp-server-spec.md`](docs/specs/mcp-server-spec.md). --- diff --git a/app/(dashboard)/settings/api-keys-panel.tsx b/app/(dashboard)/settings/api-keys-panel.tsx index 0368a31..9920ee9 100644 --- a/app/(dashboard)/settings/api-keys-panel.tsx +++ b/app/(dashboard)/settings/api-keys-panel.tsx @@ -154,6 +154,20 @@ function ConnectCard({ mintedKey }: { mintedKey: string | null }) { } } }` + const codexSnippet = `export CODEPLANS_API_KEY="${key}" +codex mcp add codeplans \\ + --url ${origin}/api/mcp/mcp \\ + --bearer-token-env-var CODEPLANS_API_KEY` + const copilotSnippet = `copilot mcp add --transport http codeplans ${origin}/api/mcp/mcp \\ + --header "Authorization: Bearer ${key}"` + const antigravitySnippet = `{ + "mcpServers": { + "codeplans": { + "serverUrl": "${origin}/api/mcp/mcp", + "headers": { "Authorization": "Bearer ${key}" } + } + } +}` function copy(label: string, text: string) { navigator.clipboard.writeText(text) @@ -188,7 +202,7 @@ function ConnectCard({ mintedKey }: { mintedKey: string | null }) {
- Use with Claude Code & Cursor + Use with your AI coding agent
{mintedKey @@ -198,9 +212,12 @@ function ConnectCard({ mintedKey }: { mintedKey: string | null }) { - + Claude Code Cursor + Codex + Copilot + Antigravity

@@ -217,6 +234,33 @@ function ConnectCard({ mintedKey }: { mintedKey: string | null }) {

+ +

+ Run once in a terminal. Codex reads the key from an env var rather than storing it in{' '} + ~/.codex/config.toml directly: +

+ +

+ Verify with codex mcp list. Re-export CODEPLANS_API_KEY in new shells, or add it to your shell profile. +

+ + +

+ GitHub Copilot CLI — run once in a terminal: +

+ +

+ Verify with copilot mcp list. In VS Code's Copilot Chat instead, add the same URL/header under a{' '} + "servers" entry in .vscode/mcp.json with "type": "http". +

+ + +

+ Add to ~/.gemini/config/mcp_config.json, then reload MCP servers from the agent panel. Note the field is{' '} + serverUrl, not url: +

+ + diff --git a/docs/index.html b/docs/index.html index c162b8b..86e4863 100644 --- a/docs/index.html +++ b/docs/index.html @@ -744,7 +744,7 @@

Current feature status

GitHub & GitLab Issues integrations (pull-only)Available Milestone-linked plans & PR auto-linkingAvailable Write-back: plan-completion comments on tracker issuesAvailable - MCP server (Claude Code/Desktop, API-key auth, 25 tools)Available + MCP server (Claude Code, Cursor, Codex, Copilot, Antigravity — API-key auth, 28 tools)Available Jira / Asana / Linear connectorsPlanned AI-assisted effort estimationPlanned diff --git a/docs/specs/mcp-server-spec.md b/docs/specs/mcp-server-spec.md index 28764e5..4e6e3f3 100644 --- a/docs/specs/mcp-server-spec.md +++ b/docs/specs/mcp-server-spec.md @@ -3,6 +3,14 @@ > **Status: SHIPPED in v0.3.1; management tools added in v0.3.2** (28 tools; plans and work items carry ownerEmail: > products, assets, dependencies, plan lifecycle/targets, full work-item edit). Companion to > `design-spec-v3.md`; reuses its data layer and access model unchanged. +> +> **Client support expanded:** the Settings → API Keys page now shows connection +> snippets for Codex CLI, GitHub Copilot (CLI + VS Code), and Antigravity, alongside Claude +> Code and Cursor. No server changes were needed — all five speak Streamable HTTP with a +> bearer-token `Authorization` header against the same `/api/mcp/mcp` endpoint; only the +> client-side config format differs (CLI command vs. JSON, and Antigravity's `serverUrl` +> field instead of `url`). See the "Connect an AI coding agent" section of the README for +> per-client snippets. ## Goal