Skip to content

Commit e62dc2c

Browse files
IvanBirukclaude
andcommitted
Bump version to 0.2.0 and restructure README for better user experience
- Increment version from 0.1.0 to 0.2.0 reflecting major FastMCP 2.0 upgrade - Reorder README sections: client integrations first, deployment modes after - Update transport references from "sse" to "http" - Make deployment section more generic (remove specific cloud provider references) - Add comprehensive deployment modes documentation with authentication patterns - Document Bearer token authentication for remote deployments - Add health check endpoint usage examples Ready for v0.2.0 release with dual-mode authentication support. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 1b3d52d commit e62dc2c

File tree

2 files changed

+36
-4
lines changed

2 files changed

+36
-4
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ The following environment variables are supported:
114114
### Command Line Options
115115

116116
* `--api-key`: Your CodeAlive API key. Overrides the `CODEALIVE_API_KEY` environment variable.
117-
* `--transport`: Transport type: `"stdio"` (default) or `"sse"`.
118-
* `--host`: Host address for SSE transport (default: `0.0.0.0`).
119-
* `--port`: Port for SSE transport (default: `8000`).
117+
* `--transport`: Transport type: `"stdio"` (default) or `"http"`.
118+
* `--host`: Host address for HTTP transport (default: `0.0.0.0`).
119+
* `--port`: Port for HTTP transport (default: `8000`).
120120
* `--debug`: Enable debug mode with verbose logging to standard output/error.
121121

122122
## Integrating with AI Clients
@@ -388,6 +388,38 @@ If you prefer not to use `uv`, you can invoke the server script directly using t
388388
}
389389
```
390390

391+
## Deployment Modes
392+
393+
The CodeAlive MCP server supports two deployment modes with different authentication patterns:
394+
395+
### Local Development (STDIO Mode)
396+
For local development and Claude Desktop integration:
397+
```bash
398+
# Requires CODEALIVE_API_KEY environment variable
399+
export CODEALIVE_API_KEY="your_api_key_here"
400+
python src/codealive_mcp_server.py --transport stdio
401+
```
402+
403+
### Remote Deployment (HTTP Mode)
404+
For remote deployment and web-based integrations:
405+
```bash
406+
# No environment variable required - uses Bearer token authentication
407+
python src/codealive_mcp_server.py --transport http --host 0.0.0.0 --port 8000
408+
409+
# Client calls with Authorization header:
410+
curl -H "Authorization: Bearer your_api_key_here" \
411+
-H "Content-Type: application/json" \
412+
-X POST https://your-server.com/mcp/ \
413+
-d '{"method": "tools/list"}'
414+
415+
# Health check endpoint:
416+
curl https://your-server.com/health
417+
```
418+
419+
**Key Differences:**
420+
- **STDIO mode**: Uses environment variable for API key, suitable for local/desktop clients
421+
- **HTTP mode**: Requires `Authorization: Bearer` header per request, suitable for web/remote clients
422+
391423
## Troubleshooting
392424

393425
If the MCP server isn't working correctly with your AI client, follow these steps:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "codealive-mcp"
3-
version = "0.1.0"
3+
version = "0.2.0"
44
description = "MCP server for the CodeAlive API"
55
readme = "README.md"
66
requires-python = "~=3.11.0"

0 commit comments

Comments
 (0)