Skip to content

Commit 692e104

Browse files
committed
docs: explain cloud MCP OAuth login
1 parent f77623e commit 692e104

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,9 @@ curl http://localhost:8000/health
279279

280280
1. **For CodeAlive Cloud (default):**
281281
- Remove `CODEALIVE_BASE_URL` environment variable (uses default `https://app.codealive.ai`)
282-
- Clients must provide their API key via `Authorization: Bearer YOUR_KEY` header
282+
- For remote clients with OAuth support, configure only `https://mcp.codealive.ai/api` and
283+
complete the browser sign-in when prompted
284+
- Existing API-key clients remain supported via `Authorization: Bearer YOUR_KEY`
283285

284286
2. **For Self-Hosted CodeAlive:**
285287
- Set `CODEALIVE_BASE_URL` to your CodeAlive instance URL (e.g., `https://codealive.yourcompany.com`)
@@ -288,6 +290,21 @@ curl http://localhost:8000/health
288290

289291
See `docker-compose.example.yml` for the complete configuration template.
290292

293+
For example, current Codex and Claude Code clients can use browser OAuth without storing a
294+
CodeAlive API key:
295+
296+
```bash
297+
codex mcp add codealive --url https://mcp.codealive.ai/api
298+
codex mcp login codealive
299+
300+
claude mcp add --transport http codealive https://mcp.codealive.ai/api
301+
# Start Claude Code and run /mcp to authenticate.
302+
```
303+
304+
Cursor and OpenCode also discover OAuth automatically from the same URL. Use
305+
`cursor-agent mcp login codealive` or `opencode mcp auth codealive` when their UI does not prompt
306+
automatically. API-key configuration remains available as a compatibility option.
307+
291308
### OAuth 2.1 deployment profile
292309

293310
Remote HTTP deployments can enable browser authorization while keeping legacy API-key clients

0 commit comments

Comments
 (0)