streamable-httpupdated 2mo ago
Docker Compose configuration for self-hosting CodeRifts on your own infrastructure.
What can you do with api governance?
CodeRifts — Self-Hosted Deployment
Docker Compose configuration for self-hosting CodeRifts on your own infrastructure.
Quick Start
CodeRifts runs from a prebuilt image published to GitHub Container Registry
(ghcr.io/coderifts/app:latest) - no source checkout or local build required.
# 1. Download the Compose file and environment template
curl -O https://raw.githubusercontent.com/coderifts/self-hosted/main/docker-compose.yml
curl -o .env https://raw.githubusercontent.com/coderifts/self-hosted/main/.env.example
# 2. Edit .env with your values (GitHub App credentials)
# 3. Pull the CodeRifts image and start all services
docker compose pull
docker compose up -d
If pulling the image requires authentication, run
docker login ghcr.iofirst.
What's Included
- docker-compose.yml — Orchestrates the CodeRifts app, PostgreSQL database, and Redis cache
- .env.example — Template for required environment variables
- SELF_HOSTED.md — Detailed deployment and configuration guide
MCP Server
CodeRifts is available as a Model Context Protocol (MCP) server so AI agents can run governance and contract-safety checks before they call or merge API changes. The server speaks MCP JSON-RPC over Streamable HTTP.
- Registry name:
io.github.coderifts/api-governance - Transport: Streamable HTTP
- Hosted endpoint:
https://app.coderifts.com/mcp - Self-hosted endpoint:
https://<your-host>/mcp(same path on your own instance) - Authentication: send
Authorization: Bearer cr_live_YOUR_KEYon tool calls. Theinitializeandtools/listmethods are open (no key required) so clients can discover the tools without authenticating.
Tools
| Tool | Description |
|---|---|
preflight_check |
Analyze an API spec diff before merge. Returns risk score, blast radius, agent impact, and a merge decision (ALLOW / WARN / REQUIRE_APPROVAL / BLOCK). |
agent_tool_check |
Check whether an API change breaks AI agent tool calling (endpoint removal, newly required fields, result-shape drift). |
agent_readiness_score |
Score an OpenAPI spec or MCP manifest for AI-agent readiness (0–100) with recommendations. |
registry_validate |
Validate an MCP tool registry or OpenAPI spec collection for governance health. |
agent_preflight |
Pre-flight governance check for agent workflows, given tool schemas before and after a change. |
mcp_diff |
Compare two MCP manifests and detect breaking changes in tool schemas, input/output types, and descriptions. |
governance_health |
Governance health score for an API spec (A–F grade, policy compliance, recommendations). |
Claude Desktop
Add CodeRifts to claude_desktop_config.json using the remote bridge:
{
"mcpServers": {
"coderifts": {
"command": "npx",
"args": [
"mcp-remote",
"https://app.coderifts.com/mcp",
"--header",
"Authorization: Bearer cr_live_YOUR_KEY"
]
}
}
}
Replace cr_live_YOUR_KEY with your CodeRifts API key, restart Claude Desktop, and the seven tools above become available.
Quick check
# List tools (no key required)
curl -s -X POST https://app.coderifts.com/mcp \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
Documentation
For full documentation, visit coderifts.com/docs.
License
See coderifts.com for licensing terms.
Install
Add api governance to your client. Pick the one you use.
claude mcp add --transport http api-governance https://app.coderifts.com/mcpcodex mcp add api-governance --url https://app.coderifts.com/mcp{
"mcpServers": {
"api-governance": {
"url": "https://app.coderifts.com/mcp"
}
}
}Add to `~/.cursor/mcp.json`, or `.cursor/mcp.json` for a single project.
{
"servers": {
"api-governance": {
"type": "http",
"url": "https://app.coderifts.com/mcp"
}
}
}Add to `.vscode/mcp.json` in your workspace.
{
"mcpServers": {
"api-governance": {
"url": "https://app.coderifts.com/mcp"
}
}
}Add to `claude_desktop_config.json`, then restart Claude Desktop.
{
"mcpServers": {
"api-governance": {
"serverUrl": "https://app.coderifts.com/mcp"
}
}
}Add to `~/.codeium/windsurf/mcp_config.json`.
7 tools
api governance exposes 7 tools to a connected agent.
- preflight_check
- Analyze an API spec diff before merge. Returns risk score, blast radius, agent impact, and a merge decision (ALLOW / WARN / REQUIRE_APPROVAL / BLOCK).
- agent_tool_check
- Check whether an API change breaks AI agent tool calling (endpoint removal, newly required fields, result-shape drift).
- agent_readiness_score
- Score an OpenAPI spec or MCP manifest for AI-agent readiness (0–100) with recommendations.
- registry_validate
- Validate an MCP tool registry or OpenAPI spec collection for governance health.
- agent_preflight
- Pre-flight governance check for agent workflows, given tool schemas before and after a change.
- mcp_diff
- Compare two MCP manifests and detect breaking changes in tool schemas, input/output types, and descriptions.
- governance_health
- Governance health score for an API spec (A–F grade, policy compliance, recommendations).
Score
62 / 100
Good
- Documentation22/25
- Maintenance16/25
- Trust6/20
- Capability6/15
- Install experience12/15
- Documents what it does and how to connect
- Has a resolvable package or endpoint
- Exposes at least one tool, prompt or resource
- README has substantive content
- Includes a code example
- Documents its configuration
- Mentions credentials or security posture
- Last commit 78 days ago
- Has a release history
- Repository is not archived
- No licence detected
- Namespace verified in the official MCP registry
- Claimed by its owner
- Published under an organisation
- 7 tool(s) documented
- Provides prompt templates
- Provides resources
- 6 documented install method(s)
- Published to a package registry
- Offers a hosted endpoint — no local install
Version history
| Versions | Published |
|---|---|
| 1.0.1Latest | Jun 15, 2026 |
| 1.0.0 | Mar 20, 2026 |