Skip to content

Commit 20ba8a1

Browse files
committed
Restructure README.md: replace AI client integration sections with collapsible details for better readability.
1 parent 0abae9d commit 20ba8a1

File tree

1 file changed

+99
-64
lines changed

1 file changed

+99
-64
lines changed

README.md

Lines changed: 99 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It allows AI-Coding Agents toL
1919
* **Find relevant code faster** with semantic search
2020
* **Understand the bigger picture** beyond isolated files
2121
* **Provide better answers** with full project context
22-
* **Reduce costs and time** by eliminating guesswork
22+
* **Reduce costs and time** by removing guesswork
2323

2424
## 🛠 Available Tools
2525

@@ -41,16 +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-
* [Claude Code](#claude-code)
45-
* [Cursor](#cursor)
46-
* [Continue](#continue)
47-
* [Visual Studio Code with GitHub Copilot](#visual-studio-code-with-github-copilot)
48-
* [Claude Desktop](#claude-desktop)
49-
* [Cline](#cline)
50-
* [Codex](#codex)
51-
* [OpenCode](#opencode)
52-
* [Qwen Code](#qwen-code)
53-
* [Gemini CLI](#gemini-cli)
5444
* [Alternative: Docker Setup](#-alternative-docker-setup)
5545
* [Advanced: Local Development](#-advanced-local-development)
5646
* [Community Plugins](#-community-plugins)
@@ -76,7 +66,8 @@ Select your preferred AI client below for instant setup:
7666

7767
## 🤖 AI Client Integrations
7868

79-
### Claude Code
69+
<details>
70+
<summary><b>Claude Code</b></summary>
8071

8172
**One command setup:**
8273

@@ -86,7 +77,10 @@ claude mcp add --transport http codealive https://mcp.codealive.ai/api --header
8677

8778
Replace `YOUR_API_KEY_HERE` with your actual API key. That's it! 🎉
8879

89-
### Cursor
80+
</details>
81+
82+
<details>
83+
<summary><b>Cursor</b></summary>
9084

9185
1. Open Cursor → Settings (`Cmd+,` or `Ctrl+,`)
9286
2. Navigate to **"MCP"** in the left panel
@@ -108,7 +102,57 @@ Replace `YOUR_API_KEY_HERE` with your actual API key. That's it! 🎉
108102

109103
5. Save and restart Cursor
110104

111-
### Continue
105+
</details>
106+
107+
<details>
108+
<summary><b>Codex</b></summary>
109+
110+
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).
111+
112+
**`~/.codex/config.toml` (Docker stdio – recommended)**
113+
```toml
114+
[mcp_servers.codealive]
115+
command = "docker"
116+
args = ["run", "--rm", "-i",
117+
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
118+
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"]
119+
```
120+
121+
> If your Codex version advertises support for remote/HTTP transports, you can try an experimental config (may not work on all versions):
122+
```toml
123+
# Experimental; if supported by your Codex build
124+
[mcp_servers.codealive]
125+
url = "https://mcp.codealive.ai/api"
126+
headers = { Authorization = "Bearer YOUR_API_KEY_HERE" }
127+
```
128+
129+
</details>
130+
131+
<details>
132+
<summary><b>Gemini CLI</b></summary>
133+
134+
Gemini CLI has first-class MCP support via `~/.gemini/settings.json` (or workspace `.gemini/settings.json`). Add CodeAlive as a **streamable-http** server.
135+
136+
```json
137+
{
138+
"mcpServers": {
139+
"codealive": {
140+
"type": "streamable-http",
141+
"url": "https://mcp.codealive.ai/api",
142+
"requestOptions": {
143+
"headers": {
144+
"Authorization": "Bearer YOUR_API_KEY_HERE"
145+
}
146+
}
147+
}
148+
}
149+
}
150+
```
151+
152+
</details>
153+
154+
<details>
155+
<summary><b>Continue</b></summary>
112156

113157
1. Create/edit `.continue/config.yaml` in your project or `~/.continue/config.yaml`
114158
2. Add this configuration:
@@ -117,15 +161,18 @@ Replace `YOUR_API_KEY_HERE` with your actual API key. That's it! 🎉
117161
mcpServers:
118162
- name: CodeAlive
119163
type: streamable-http
120-
url: https://mcp.codealive.ai/api
164+
url: https://mcp.codealive.ai/api
121165
requestOptions:
122166
headers:
123167
Authorization: "Bearer YOUR_API_KEY_HERE"
124168
```
125169
126170
3. Restart VS Code
127171
128-
### Visual Studio Code with GitHub Copilot
172+
</details>
173+
174+
<details>
175+
<summary><b>Visual Studio Code with GitHub Copilot</b></summary>
129176
130177
1. Open Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
131178
2. Run **"MCP: Add Server"**
@@ -148,11 +195,17 @@ mcpServers:
148195

149196
5. Restart VS Code
150197

151-
### Claude Desktop
198+
</details>
199+
200+
<details>
201+
<summary><b>Claude Desktop</b></summary>
152202

153203
> **Note:** Claude Desktop remote MCP requires OAuth authentication. Use Docker option below for Bearer token support.
154204

155-
### Cline
205+
</details>
206+
207+
<details>
208+
<summary><b>Cline</b></summary>
156209

157210
1. Open Cline extension in VS Code
158211
2. Click the MCP Servers icon to configure
@@ -173,28 +226,10 @@ mcpServers:
173226

174227
4. Save and restart VS Code
175228

176-
### Codex
177-
178-
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).
179-
180-
**`~/.codex/config.toml` (Docker stdio – recommended)**
181-
```toml
182-
[mcp_servers.codealive]
183-
command = "docker"
184-
args = ["run", "--rm", "-i",
185-
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
186-
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"]
187-
```
188-
189-
> If your Codex version advertises support for remote/HTTP transports, you can try an experimental config (may not work on all versions):
190-
```toml
191-
# Experimental; if supported by your Codex build
192-
[mcp_servers.codealive]
193-
url = "https://mcp.codealive.ai/api"
194-
headers = { Authorization = "Bearer YOUR_API_KEY_HERE" }
195-
```
229+
</details>
196230

197-
### OpenCode
231+
<details>
232+
<summary><b>OpenCode</b></summary>
198233

199234
Add CodeAlive as a **remote** MCP server in your `opencode.json`.
200235

@@ -214,7 +249,10 @@ Add CodeAlive as a **remote** MCP server in your `opencode.json`.
214249
}
215250
```
216251

217-
### Qwen Code
252+
</details>
253+
254+
<details>
255+
<summary><b>Qwen Code</b></summary>
218256

219257
Qwen Code supports MCP via `mcpServers` in its `settings.json` and multiple transports (stdio/SSE/streamable-http). Use **streamable-http** when available; otherwise use Docker (stdio).
220258

@@ -250,33 +288,16 @@ Qwen Code supports MCP via `mcpServers` in its `settings.json` and multiple tran
250288
}
251289
```
252290

253-
### Gemini CLI
254-
255-
Gemini CLI has first-class MCP support via `~/.gemini/settings.json` (or workspace `.gemini/settings.json`). Add CodeAlive as a **streamable-http** server.
256-
257-
```json
258-
{
259-
"mcpServers": {
260-
"codealive": {
261-
"type": "streamable-http",
262-
"url": "https://mcp.codealive.ai/api",
263-
"requestOptions": {
264-
"headers": {
265-
"Authorization": "Bearer YOUR_API_KEY_HERE"
266-
}
267-
}
268-
}
269-
}
270-
}
271-
```
291+
</details>
272292

273293
---
274294

275295
## 🐳 Alternative: Docker Setup
276296

277297
If you prefer Docker over the remote service, use our Docker image:
278298

279-
### Claude Desktop with Docker
299+
<details>
300+
<summary><b>Claude Desktop with Docker</b></summary>
280301

281302
For local development or if you prefer Docker over the remote service:
282303

@@ -303,7 +324,10 @@ For local development or if you prefer Docker over the remote service:
303324

304325
3. Restart Claude Desktop
305326

306-
### Cursor with Docker
327+
</details>
328+
329+
<details>
330+
<summary><b>Cursor with Docker</b></summary>
307331

308332
```json
309333
{
@@ -320,7 +344,10 @@ For local development or if you prefer Docker over the remote service:
320344
}
321345
```
322346

323-
### Continue with Docker
347+
</details>
348+
349+
<details>
350+
<summary><b>Continue with Docker</b></summary>
324351

325352
```yaml
326353
mcpServers:
@@ -336,7 +363,10 @@ mcpServers:
336363
- ghcr.io/codealive-ai/codealive-mcp:v0.2.0
337364
```
338365

339-
### VS Code with Docker
366+
</details>
367+
368+
<details>
369+
<summary><b>VS Code with Docker</b></summary>
340370

341371
Create `.vscode/mcp.json` in your workspace:
342372

@@ -355,7 +385,10 @@ Create `.vscode/mcp.json` in your workspace:
355385
}
356386
```
357387

358-
### Cline with Docker
388+
</details>
389+
390+
<details>
391+
<summary><b>Cline with Docker</b></summary>
359392

360393
1. Open Cline extension in VS Code
361394
2. Click the MCP Servers icon to configure
@@ -376,6 +409,8 @@ Create `.vscode/mcp.json` in your workspace:
376409
}
377410
```
378411

412+
</details>
413+
379414
---
380415

381416
## 🔧 Advanced: Local Development

0 commit comments

Comments
 (0)