Skip to content

Commit 7df7812

Browse files
committed
Restructure README.md: consolidate and expand Docker setup details into collapsible sections, emphasizing Remote HTTP as the recommended option and simplifying integration steps.
1 parent 13e4f6e commit 7df7812

File tree

1 file changed

+111
-125
lines changed

1 file changed

+111
-125
lines changed

README.md

Lines changed: 111 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ After setup, try these commands with your AI assistant:
4141

4242
* [Quick Start (Remote)](#-quick-start-remote)
4343
* [AI Client Integrations](#-ai-client-integrations)
44-
* [Alternative: Docker Setup](#-alternative-docker-setup)
4544
* [Advanced: Local Development](#-advanced-local-development)
4645
* [Community Plugins](#-community-plugins)
4746
* [Available Tools](#-available-tools)
@@ -69,19 +68,27 @@ Select your preferred AI client below for instant setup:
6968
<details>
7069
<summary><b>Claude Code</b></summary>
7170

72-
**One command setup:**
71+
**Option 1: Remote HTTP (Recommended)**
7372

7473
```bash
7574
claude mcp add --transport http codealive https://mcp.codealive.ai/api --header "Authorization: Bearer YOUR_API_KEY_HERE"
7675
```
7776

78-
Replace `YOUR_API_KEY_HERE` with your actual API key. That's it! 🎉
77+
**Option 2: Docker (STDIO)**
78+
79+
```bash
80+
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
81+
```
82+
83+
Replace `YOUR_API_KEY_HERE` with your actual API key.
7984

8085
</details>
8186

8287
<details>
8388
<summary><b>Cursor</b></summary>
8489

90+
**Option 1: Remote HTTP (Recommended)**
91+
8592
1. Open Cursor → Settings (`Cmd+,` or `Ctrl+,`)
8693
2. Navigate to **"MCP"** in the left panel
8794
3. Click **"Add new MCP server"**
@@ -102,6 +109,23 @@ Replace `YOUR_API_KEY_HERE` with your actual API key. That's it! 🎉
102109

103110
5. Save and restart Cursor
104111

112+
**Option 2: Docker (STDIO)**
113+
114+
```json
115+
{
116+
"mcpServers": {
117+
"codealive": {
118+
"command": "docker",
119+
"args": [
120+
"run", "--rm", "-i",
121+
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
122+
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
123+
]
124+
}
125+
}
126+
}
127+
```
128+
105129
</details>
106130

107131
<details>
@@ -154,6 +178,8 @@ Gemini CLI has first-class MCP support via `~/.gemini/settings.json` (or workspa
154178
<details>
155179
<summary><b>Continue</b></summary>
156180

181+
**Option 1: Remote HTTP (Recommended)**
182+
157183
1. Create/edit `.continue/config.yaml` in your project or `~/.continue/config.yaml`
158184
2. Add this configuration:
159185

@@ -169,11 +195,29 @@ mcpServers:
169195
170196
3. Restart VS Code
171197
198+
**Option 2: Docker (STDIO)**
199+
200+
```yaml
201+
mcpServers:
202+
- name: CodeAlive
203+
type: stdio
204+
command: docker
205+
args:
206+
- run
207+
- --rm
208+
- -i
209+
- -e
210+
- CODEALIVE_API_KEY=YOUR_API_KEY_HERE
211+
- ghcr.io/codealive-ai/codealive-mcp:v0.2.0
212+
```
213+
172214
</details>
173215
174216
<details>
175217
<summary><b>Visual Studio Code with GitHub Copilot</b></summary>
176218
219+
**Option 1: Remote HTTP (Recommended)**
220+
177221
1. Open Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
178222
2. Run **"MCP: Add Server"**
179223
3. Choose **"HTTP"** server type
@@ -195,18 +239,64 @@ mcpServers:
195239

196240
5. Restart VS Code
197241

242+
**Option 2: Docker (STDIO)**
243+
244+
Create `.vscode/mcp.json` in your workspace:
245+
246+
```json
247+
{
248+
"servers": {
249+
"codealive": {
250+
"command": "docker",
251+
"args": [
252+
"run", "--rm", "-i",
253+
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
254+
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
255+
]
256+
}
257+
}
258+
}
259+
```
260+
198261
</details>
199262

200263
<details>
201264
<summary><b>Claude Desktop</b></summary>
202265

203-
> **Note:** Claude Desktop remote MCP requires OAuth authentication. Use Docker option below for Bearer token support.
266+
> **Note:** Claude Desktop remote MCP requires OAuth authentication. Use Docker option for Bearer token support.
267+
268+
**Docker (STDIO)**
269+
270+
1. Edit your config file:
271+
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
272+
- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
273+
274+
2. Add this configuration:
275+
276+
```json
277+
{
278+
"mcpServers": {
279+
"codealive": {
280+
"command": "docker",
281+
"args": [
282+
"run", "--rm", "-i",
283+
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
284+
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
285+
]
286+
}
287+
}
288+
}
289+
```
290+
291+
3. Restart Claude Desktop
204292

205293
</details>
206294

207295
<details>
208296
<summary><b>Cline</b></summary>
209297

298+
**Option 1: Remote HTTP (Recommended)**
299+
210300
1. Open Cline extension in VS Code
211301
2. Click the MCP Servers icon to configure
212302
3. Add this configuration to your MCP settings:
@@ -226,6 +316,23 @@ mcpServers:
226316

227317
4. Save and restart VS Code
228318

319+
**Option 2: Docker (STDIO)**
320+
321+
```json
322+
{
323+
"mcpServers": {
324+
"codealive": {
325+
"command": "docker",
326+
"args": [
327+
"run", "--rm", "-i",
328+
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
329+
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
330+
]
331+
}
332+
}
333+
}
334+
```
335+
229336
</details>
230337

231338
<details>
@@ -560,127 +667,6 @@ Use the IDE UI: Q panel → Chat → tools icon → Add MCP Server → choose ht
560667

561668
---
562669

563-
## 🐳 Alternative: Docker Setup
564-
565-
If you prefer Docker over the remote service, use our Docker image:
566-
567-
<details>
568-
<summary><b>Claude Desktop with Docker</b></summary>
569-
570-
For local development or if you prefer Docker over the remote service:
571-
572-
1. Edit your config file:
573-
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
574-
- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
575-
576-
2. Add this configuration:
577-
578-
```json
579-
{
580-
"mcpServers": {
581-
"codealive": {
582-
"command": "docker",
583-
"args": [
584-
"run", "--rm", "-i",
585-
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
586-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
587-
]
588-
}
589-
}
590-
}
591-
```
592-
593-
3. Restart Claude Desktop
594-
595-
</details>
596-
597-
<details>
598-
<summary><b>Cursor with Docker</b></summary>
599-
600-
```json
601-
{
602-
"mcpServers": {
603-
"codealive": {
604-
"command": "docker",
605-
"args": [
606-
"run", "--rm", "-i",
607-
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
608-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
609-
]
610-
}
611-
}
612-
}
613-
```
614-
615-
</details>
616-
617-
<details>
618-
<summary><b>Continue with Docker</b></summary>
619-
620-
```yaml
621-
mcpServers:
622-
- name: CodeAlive
623-
type: stdio
624-
command: docker
625-
args:
626-
- run
627-
- --rm
628-
- -i
629-
- -e
630-
- CODEALIVE_API_KEY=YOUR_API_KEY_HERE
631-
- ghcr.io/codealive-ai/codealive-mcp:v0.2.0
632-
```
633-
634-
</details>
635-
636-
<details>
637-
<summary><b>VS Code with Docker</b></summary>
638-
639-
Create `.vscode/mcp.json` in your workspace:
640-
641-
```json
642-
{
643-
"servers": {
644-
"codealive": {
645-
"command": "docker",
646-
"args": [
647-
"run", "--rm", "-i",
648-
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
649-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
650-
]
651-
}
652-
}
653-
}
654-
```
655-
656-
</details>
657-
658-
<details>
659-
<summary><b>Cline with Docker</b></summary>
660-
661-
1. Open Cline extension in VS Code
662-
2. Click the MCP Servers icon to configure
663-
3. Add this Docker configuration:
664-
665-
```json
666-
{
667-
"mcpServers": {
668-
"codealive": {
669-
"command": "docker",
670-
"args": [
671-
"run", "--rm", "-i",
672-
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
673-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"
674-
]
675-
}
676-
}
677-
}
678-
```
679-
680-
</details>
681-
682-
---
683-
684670
## 🔧 Advanced: Local Development
685671

686672
**For developers who want to customize or contribute to the MCP server.**

0 commit comments

Comments
 (0)