Skip to content

Commit 339b11d

Browse files
rodion-mclaude
andcommitted
Sync README: Cursor UI path and Codex multi-form-factor MCP setup
Cursor: - Update UI path to Tools & MCP > New MCP Server (older builds: Tools & Integrations) - Note .cursor/mcp.json / ~/.cursor/mcp.json file locations - Mention one-click install deeplink Codex (renamed section to "Codex (CLI, App, IDE Extension)"): - Note that Codex CLI, Codex App, and Codex IDE Extension all share ~/.codex/config.toml - Add `codex mcp add codealive --url ...` one-line install - Switch HTTP example to bearer_token_env_var over inline Authorization header - Add [features].rmcp_client = true flag (required for Streamable HTTP) - Note deprecation of top-level experimental_use_rmcp_client flag - Use env_vars for Docker STDIO instead of inline -e - Mention Codex App Settings > MCP Servers UI writes the same config file Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d73501d commit 339b11d

1 file changed

Lines changed: 49 additions & 12 deletions

File tree

README.md

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ Replace `YOUR_API_KEY_HERE` with your actual API key.
140140
**Option 1: Remote HTTP (Recommended)**
141141

142142
1. Open Cursor → Settings (`Cmd+,` or `Ctrl+,`)
143-
2. Navigate to **"MCP"** in the left panel
144-
3. Click **"Add new MCP server"**
143+
2. Navigate to **"Tools & MCP"** in the left panel (older builds called this **"Tools & Integrations"**)
144+
3. Click **"New MCP Server"**
145145
4. Paste this configuration:
146146

147147
```json
@@ -157,7 +157,9 @@ Replace `YOUR_API_KEY_HERE` with your actual API key.
157157
}
158158
```
159159

160-
5. Save and restart Cursor
160+
5. Save — Cursor reloads the server automatically. The entry is stored in `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global).
161+
162+
> **Tip:** Cursor also supports a one-click install deeplink — `cursor://anysphere.cursor-deeplink/mcp/install?name=codealive&config=BASE64_CONFIG`. Only follow deeplinks from trusted sources.
161163
162164
**Option 2: Docker (STDIO)**
163165

@@ -179,29 +181,64 @@ Replace `YOUR_API_KEY_HERE` with your actual API key.
179181
</details>
180182

181183
<details>
182-
<summary><b>Codex</b></summary>
184+
<summary><b>Codex (CLI, App, IDE Extension)</b></summary>
185+
186+
OpenAI Codex ships in three form-factors that **share the same configuration**: the **Codex CLI**, the **Codex App** (macOS / Windows), and the **Codex IDE Extension** (VS Code `openai.chatgpt` and JetBrains 2025.3+). All three read `~/.codex/config.toml`, so one snippet covers every Codex surface. A project-level `.codex/config.toml` in the repo root is also supported for trusted projects.
183187

184-
OpenAI Codex CLI supports MCP via `~/.codex/config.toml`.
188+
**Option 1: One-line add (Recommended)**
189+
190+
```bash
191+
codex mcp add codealive --url https://mcp.codealive.ai/api
192+
```
193+
194+
Then open `~/.codex/config.toml` and add the bearer-token reference plus the Streamable HTTP feature flag:
185195

186-
**`~/.codex/config.toml` (Docker stdio – recommended)**
187196
```toml
197+
[features]
198+
rmcp_client = true
199+
188200
[mcp_servers.codealive]
189-
command = "docker"
190-
args = ["run", "--rm", "-i",
191-
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
192-
"ghcr.io/codealive-ai/codealive-mcp:main"]
201+
url = "https://mcp.codealive.ai/api"
202+
bearer_token_env_var = "CODEALIVE_API_KEY"
203+
```
204+
205+
Finally, export the key:
206+
```bash
207+
export CODEALIVE_API_KEY="YOUR_API_KEY_HERE"
193208
```
194209

195-
**Experimental: Streamable HTTP (requires `[features].rmcp_client = true`)**
210+
Verify with `codex mcp list`.
196211

197-
> **Note:** Streamable HTTP support requires `rmcp_client = true` under a `[features]` section in your Codex configuration.
212+
> **Note:** Streamable HTTP requires `[features].rmcp_client = true`. The old top-level `experimental_use_rmcp_client = true` flag is deprecated. `bearer_token_env_var` is preferred over inline `headers = { Authorization = "Bearer …" }` because it keeps secrets out of the config file.
213+
214+
**Option 2: Inline header (HTTP)**
198215

199216
```toml
217+
[features]
218+
rmcp_client = true
219+
200220
[mcp_servers.codealive]
201221
url = "https://mcp.codealive.ai/api"
202222
headers = { Authorization = "Bearer YOUR_API_KEY_HERE" }
203223
```
204224

225+
**Option 3: Docker (STDIO)**
226+
227+
```toml
228+
[mcp_servers.codealive]
229+
command = "docker"
230+
args = ["run", "--rm", "-i", "ghcr.io/codealive-ai/codealive-mcp:main"]
231+
env_vars = ["CODEALIVE_API_KEY"]
232+
```
233+
234+
```bash
235+
export CODEALIVE_API_KEY="YOUR_API_KEY_HERE"
236+
```
237+
238+
No `[features]` flag is needed for stdio. `env_vars` forwards values from the parent shell — safer than embedding the key in `args`.
239+
240+
**Codex App UI:** Settings → MCP Servers → Add Server. The UI writes the same `~/.codex/config.toml` entry. The CLI and IDE extension pick it up automatically.
241+
205242
</details>
206243

207244
<details>

0 commit comments

Comments
 (0)