|
| 1 | +# Deployment Guide |
| 2 | + |
| 3 | +This guide covers publishing CodeAlive MCP to the MCP Registry. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +### Install mcp-publisher |
| 8 | + |
| 9 | +Build from source (documented install methods like `brew install` and `install.sh` are not available): |
| 10 | + |
| 11 | +```bash |
| 12 | +git clone https://github.com/modelcontextprotocol/registry.git |
| 13 | +cd registry |
| 14 | +make publisher |
| 15 | +``` |
| 16 | + |
| 17 | +The binary will be at `./bin/mcp-publisher`. |
| 18 | + |
| 19 | +### GitHub org membership (for org repos) |
| 20 | + |
| 21 | +Your organization membership must be public: |
| 22 | +1. Go to https://github.com/orgs/CodeAlive-AI/people |
| 23 | +2. Find your username and set visibility to "Public" |
| 24 | + |
| 25 | +## Publishing to MCP Registry |
| 26 | + |
| 27 | +### 1. Login with GitHub |
| 28 | + |
| 29 | +```bash |
| 30 | +./bin/mcp-publisher login github |
| 31 | +``` |
| 32 | + |
| 33 | +Follow the device authorization flow: |
| 34 | +1. Go to the URL shown (e.g., https://github.com/login/device) |
| 35 | +2. Enter the code displayed |
| 36 | +3. Authorize the application |
| 37 | + |
| 38 | +### 2. Update server.json |
| 39 | + |
| 40 | +Before publishing, update `server.json`: |
| 41 | + |
| 42 | +1. **Bump the version** field to match your release |
| 43 | +2. **Use the latest schema** (currently `2025-12-11`) |
| 44 | +3. **Update package identifier** with new version tag |
| 45 | + |
| 46 | +Example `server.json` structure: |
| 47 | +```json |
| 48 | +{ |
| 49 | + "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json", |
| 50 | + "name": "io.github.CodeAlive-AI/codealive-mcp", |
| 51 | + "version": "0.4.7", |
| 52 | + ... |
| 53 | + "packages": [ |
| 54 | + { |
| 55 | + "registryType": "oci", |
| 56 | + "identifier": "ghcr.io/codealive-ai/codealive-mcp:0.4.7", |
| 57 | + "runtimeHint": "docker", |
| 58 | + ... |
| 59 | + } |
| 60 | + ] |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +**Important notes:** |
| 65 | +- OCI packages must NOT have a separate `version` field inside the package object - the version is embedded in the `identifier` tag |
| 66 | +- Schema version must be current (check [changelog](https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/server-json/CHANGELOG.md)) |
| 67 | + |
| 68 | +### 3. Publish |
| 69 | + |
| 70 | +```bash |
| 71 | +cd /path/to/codealive-mcp |
| 72 | +/path/to/registry/bin/mcp-publisher publish |
| 73 | +``` |
| 74 | + |
| 75 | +On success: |
| 76 | +``` |
| 77 | +Publishing to https://registry.modelcontextprotocol.io... |
| 78 | +✓ Successfully published |
| 79 | +✓ Server io.github.CodeAlive-AI/codealive-mcp version 0.4.7 |
| 80 | +``` |
| 81 | + |
| 82 | +## Troubleshooting |
| 83 | + |
| 84 | +### "not authenticated" |
| 85 | +Re-run login: |
| 86 | +```bash |
| 87 | +./bin/mcp-publisher login github |
| 88 | +``` |
| 89 | + |
| 90 | +### "403: your GitHub account doesn't have permission" |
| 91 | +Make your organization membership public: |
| 92 | +1. Go to https://github.com/orgs/CodeAlive-AI/people |
| 93 | +2. Find your username |
| 94 | +3. Change visibility to "Public" |
| 95 | +4. Re-login and try again |
| 96 | + |
| 97 | +### "deprecated schema detected" |
| 98 | +Update `$schema` in `server.json` to the current version. Check the [migration checklist](https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/server-json/CHANGELOG.md#migration-checklist-for-publishers). |
| 99 | + |
| 100 | +### "OCI packages must not have 'version' field" |
| 101 | +Remove the `version` field from inside the `packages` array. The version should only appear in the `identifier` tag (e.g., `ghcr.io/codealive-ai/codealive-mcp:0.4.7`). |
| 102 | + |
| 103 | +## Version Guidelines |
| 104 | + |
| 105 | +- **Patch** (0.4.6 → 0.4.7): Bug fixes, minor improvements |
| 106 | +- **Minor** (0.4.0 → 0.5.0): New features, enhancements |
| 107 | +- **Major** (0.x.x → 1.0.0): Breaking changes, major releases |
| 108 | + |
| 109 | +## Related Resources |
| 110 | + |
| 111 | +- [MCP Registry](https://registry.modelcontextprotocol.io/) |
| 112 | +- [server.json Schema Changelog](https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/server-json/CHANGELOG.md) |
| 113 | +- [MCP Registry GitHub](https://github.com/modelcontextprotocol/registry) |
0 commit comments