Skip to content

Commit 0abae9d

Browse files
committed
Expand README.md with setup instructions and support details for new AI clients: Codex, OpenCode, Qwen Code, and Gemini CLI, along with community plugin information.
1 parent f90d2b3 commit 0abae9d

File tree

1 file changed

+131
-1
lines changed

1 file changed

+131
-1
lines changed

README.md

Lines changed: 131 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
**Connect your AI assistant to CodeAlive's powerful code understanding platform in seconds!**
1010

11-
This MCP (Model Context Protocol) server enables AI clients like Claude Code, Cursor, Claude Desktop, Continue, VS Code (GitHub Copilot), and Cline to access CodeAlive's advanced semantic code search and codebase interaction features.
11+
This MCP (Model Context Protocol) server enables AI clients like Claude Code, Cursor, Claude Desktop, Continue, VS Code (GitHub Copilot), Cline, Codex, OpenCode, Qwen Code, and Gemini CLI to access CodeAlive's advanced semantic code search and codebase interaction features.
1212

1313
## What is CodeAlive?
1414

@@ -47,8 +47,13 @@ After setup, try these commands with your AI assistant:
4747
* [Visual Studio Code with GitHub Copilot](#visual-studio-code-with-github-copilot)
4848
* [Claude Desktop](#claude-desktop)
4949
* [Cline](#cline)
50+
* [Codex](#codex)
51+
* [OpenCode](#opencode)
52+
* [Qwen Code](#qwen-code)
53+
* [Gemini CLI](#gemini-cli)
5054
* [Alternative: Docker Setup](#-alternative-docker-setup)
5155
* [Advanced: Local Development](#-advanced-local-development)
56+
* [Community Plugins](#-community-plugins)
5257
* [Available Tools](#-available-tools)
5358
* [Usage Examples](#-usage-examples)
5459
* [Troubleshooting](#-troubleshooting)
@@ -168,6 +173,103 @@ mcpServers:
168173

169174
4. Save and restart VS Code
170175

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+
```
196+
197+
### OpenCode
198+
199+
Add CodeAlive as a **remote** MCP server in your `opencode.json`.
200+
201+
```json
202+
{
203+
"$schema": "https://opencode.ai/config.json",
204+
"mcp": {
205+
"codealive": {
206+
"type": "remote",
207+
"url": "https://mcp.codealive.ai/api",
208+
"enabled": true,
209+
"headers": {
210+
"Authorization": "Bearer YOUR_API_KEY_HERE"
211+
}
212+
}
213+
}
214+
}
215+
```
216+
217+
### Qwen Code
218+
219+
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).
220+
221+
**`~/.qwen/settings.json` (Streamable HTTP)**
222+
```json
223+
{
224+
"mcpServers": {
225+
"codealive": {
226+
"type": "streamable-http",
227+
"url": "https://mcp.codealive.ai/api",
228+
"requestOptions": {
229+
"headers": {
230+
"Authorization": "Bearer YOUR_API_KEY_HERE"
231+
}
232+
}
233+
}
234+
}
235+
}
236+
```
237+
238+
**Fallback: Docker (stdio)**
239+
```json
240+
{
241+
"mcpServers": {
242+
"codealive": {
243+
"type": "stdio",
244+
"command": "docker",
245+
"args": ["run", "--rm", "-i",
246+
"-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
247+
"ghcr.io/codealive-ai/codealive-mcp:v0.2.0"]
248+
}
249+
}
250+
}
251+
```
252+
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+
```
272+
171273
---
172274

173275
## 🐳 Alternative: Docker Setup
@@ -345,6 +447,34 @@ npx -y @smithery/cli install @CodeAlive-AI/codealive-mcp --client claude
345447

346448
---
347449

450+
## 🌐 Community Plugins
451+
452+
### Gemini CLI — CodeAlive Extension
453+
454+
**Repo:** https://github.com/akolotov/gemini-cli-codealive-extension
455+
456+
Gemini CLI extension that wires CodeAlive into your terminal with prebuilt slash commands and MCP config. It includes:
457+
- `GEMINI.md` guidance so Gemini knows how to use CodeAlive tools effectively
458+
- Slash commands: `/codealive:chat`, `/codealive:find`, `/codealive:search`
459+
- Easy setup via Gemini CLI's extension system
460+
461+
**Install**
462+
```bash
463+
gemini extensions install https://github.com/akolotov/gemini-cli-codealive-extension
464+
```
465+
466+
**Configure**
467+
```bash
468+
# Option 1: .env next to where you run `gemini`
469+
CODEALIVE_API_KEY="your_codealive_api_key_here"
470+
471+
# Option 2: environment variable
472+
export CODEALIVE_API_KEY="your_codealive_api_key_here"
473+
gemini
474+
```
475+
476+
---
477+
348478
## 🐞 Troubleshooting
349479

350480
### Quick Diagnostics

0 commit comments

Comments
 (0)