Skip to content

Commit f73f80b

Browse files
committed
Update README.md: change mcpServers.codealive.type to streamable-http for consistency
1 parent 8b3aeac commit f73f80b

File tree

2 files changed

+43
-28
lines changed

2 files changed

+43
-28
lines changed

PUBLISHING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Users can access your MCP server in two ways:
4545
"command": "docker",
4646
"args": [
4747
"run", "--rm", "-i", "-e", "CODEALIVE_API_KEY",
48-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
48+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
4949
]
5050
},
5151
"env": {
@@ -54,7 +54,7 @@ Users can access your MCP server in two ways:
5454
}
5555
```
5656

57-
> Replace `v0.2.0` with the version being published.
57+
> Replace `v0.3.0` with the version being published.
5858
5959
### Option 2: Remote HTTP Endpoint (Cloud)
6060
```json

README.md

Lines changed: 41 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ claude mcp add --transport http codealive https://mcp.codealive.ai/api --header
9999
**Option 2: Docker (STDIO)**
100100

101101
```bash
102-
claude mcp add codealive-docker /usr/bin/docker run --rm -i -e CODEALIVE_API_KEY=YOUR_API_KEY_HERE ghcr.io/codealive-ai/codealive-mcp:v0.2.0
102+
claude mcp add codealive-docker /usr/bin/docker run --rm -i -e CODEALIVE_API_KEY=YOUR_API_KEY_HERE ghcr.io/codealive-ai/codealive-mcp:v0.3.0
103103
```
104104

105105
Replace `YOUR_API_KEY_HERE` with your actual API key.
@@ -141,7 +141,7 @@ Replace `YOUR_API_KEY_HERE` with your actual API key.
141141
"args": [
142142
"run", "--rm", "-i",
143143
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
144-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
144+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
145145
]
146146
}
147147
}
@@ -153,20 +153,22 @@ Replace `YOUR_API_KEY_HERE` with your actual API key.
153153
<details>
154154
<summary><b>Codex</b></summary>
155155

156-
OpenAI Codex CLI supports MCP via `~/.codex/config.toml`. Remote HTTP MCP is still evolving; the most reliable way today is to launch CodeAlive via Docker (stdio).
156+
OpenAI Codex CLI supports MCP via `~/.codex/config.toml`.
157157

158158
**`~/.codex/config.toml` (Docker stdio – recommended)**
159159
```toml
160160
[mcp_servers.codealive]
161161
command = "docker"
162162
args = ["run", "--rm", "-i",
163163
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
164-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"]
164+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"]
165165
```
166166

167-
> If your Codex version advertises support for remote/HTTP transports, you can try an experimental config (may not work on all versions):
167+
**Experimental: Streamable HTTP (requires experimental_use_rmcp_client)**
168+
169+
> **Note:** Streamable HTTP support requires enabling the experimental Rust MCP client in your Codex configuration.
170+
168171
```toml
169-
# Experimental; if supported by your Codex build
170172
[mcp_servers.codealive]
171173
url = "https://mcp.codealive.ai/api"
172174
headers = { Authorization = "Bearer YOUR_API_KEY_HERE" }
@@ -220,7 +222,7 @@ mcpServers:
220222
- -i
221223
- -e
222224
- CODEALIVE_API_KEY=YOUR_API_KEY_HERE
223-
- ghcr.io/codealive-ai/codealive-mcp:v0.2.0
225+
- ghcr.io/codealive-ai/codealive-mcp:v0.3.0
224226
```
225227
226228
</details>
@@ -230,6 +232,8 @@ mcpServers:
230232
231233
**Option 1: Remote HTTP (Recommended)**
232234
235+
> **Note:** VS Code supports both Streamable HTTP and SSE transports, with automatic fallback to SSE if Streamable HTTP fails.
236+
233237
1. Open Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
234238
2. Run **"MCP: Add Server"**
235239
3. Choose **"HTTP"** server type
@@ -263,7 +267,7 @@ Create `.vscode/mcp.json` in your workspace:
263267
"args": [
264268
"run", "--rm", "-i",
265269
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
266-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
270+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
267271
]
268272
}
269273
}
@@ -293,7 +297,7 @@ Create `.vscode/mcp.json` in your workspace:
293297
"args": [
294298
"run", "--rm", "-i",
295299
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
296-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
300+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
297301
]
298302
}
299303
}
@@ -338,7 +342,7 @@ Create `.vscode/mcp.json` in your workspace:
338342
"args": [
339343
"run", "--rm", "-i",
340344
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
341-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
345+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
342346
]
343347
}
344348
}
@@ -401,7 +405,7 @@ Qwen Code supports MCP via `mcpServers` in its `settings.json` and multiple tran
401405
"command": "docker",
402406
"args": ["run", "--rm", "-i",
403407
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
404-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"]
408+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"]
405409
}
406410
}
407411
}
@@ -441,7 +445,7 @@ Roo Code reads a JSON settings file similar to Cline.
441445
"args": [
442446
"run", "--rm", "-i",
443447
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
444-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
448+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
445449
]
446450
}
447451
}
@@ -466,7 +470,7 @@ Roo Code reads a JSON settings file similar to Cline.
466470

467471
Add a STDIO extension with:
468472
- **Command:** `docker`
469-
- **Args:** `run --rm -i -e CODEALIVE_API_KEY=YOUR_API_KEY_HERE ghcr.io/codealive-ai/codealive-mcp:v0.2.0`
473+
- **Args:** `run --rm -i -e CODEALIVE_API_KEY=YOUR_API_KEY_HERE ghcr.io/codealive-ai/codealive-mcp:v0.3.0`
470474

471475
</details>
472476

@@ -500,7 +504,7 @@ Add a STDIO extension with:
500504
"args": [
501505
"run", "--rm", "-i",
502506
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
503-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
507+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
504508
]
505509
}
506510
}
@@ -518,7 +522,7 @@ Add a STDIO extension with:
518522
{
519523
"mcpServers": {
520524
"codealive": {
521-
"type": "http",
525+
"type": "streamable-http",
522526
"serverUrl": "https://mcp.codealive.ai/api",
523527
"headers": {
524528
"Authorization": "Bearer YOUR_API_KEY_HERE"
@@ -528,34 +532,45 @@ Add a STDIO extension with:
528532
}
529533
```
530534

531-
> **Note:** Product name is Windsurf.
532-
533535
</details>
534536

535537
<details>
536538
<summary><b>Kiro</b></summary>
537539

540+
> **Note:** Kiro does not yet support remote MCP servers natively. Use the `mcp-remote` workaround to connect to remote HTTP servers.
541+
542+
**Prerequisites:**
543+
```bash
544+
npm install -g mcp-remote
545+
```
546+
538547
**UI path:** Settings → MCP → Add Server
539548

540549
**Global file:** `~/.kiro/settings/mcp.json`
541550
**Workspace file:** `.kiro/settings/mcp.json`
542551

543-
**HTTP**
552+
**Remote HTTP (via mcp-remote workaround)**
544553
```json
545554
{
546555
"mcpServers": {
547556
"codealive": {
548-
"type": "http",
549-
"url": "https://mcp.codealive.ai/api",
550-
"headers": {
551-
"Authorization": "Bearer YOUR_API_KEY_HERE"
557+
"type": "stdio",
558+
"command": "npx",
559+
"args": [
560+
"mcp-remote",
561+
"https://mcp.codealive.ai/api",
562+
"--header",
563+
"Authorization: Bearer ${CODEALIVE_API_KEY}"
564+
],
565+
"env": {
566+
"CODEALIVE_API_KEY": "YOUR_API_KEY_HERE"
552567
}
553568
}
554569
}
555570
}
556571
```
557572

558-
**STDIO (Docker)**
573+
**Docker (STDIO)**
559574
```json
560575
{
561576
"mcpServers": {
@@ -565,7 +580,7 @@ Add a STDIO extension with:
565580
"args": [
566581
"run", "--rm", "-i",
567582
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
568-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
583+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
569584
]
570585
}
571586
}
@@ -604,7 +619,7 @@ Add a STDIO extension with:
604619
"args": [
605620
"run", "--rm", "-i",
606621
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
607-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
622+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
608623
]
609624
}
610625
}
@@ -645,7 +660,7 @@ Add a STDIO extension with:
645660
"args": [
646661
"run", "--rm", "-i",
647662
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
648-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
663+
"ghcr.io/codealive-ai/codealive-mcp:v0.3.0"
649664
]
650665
}
651666
}

0 commit comments

Comments
 (0)