Docs

Build with Carrick

Carrick is a live, type-aware, intent-aware cross-repo index of every TypeScript service in your GitHub org, exposed to AI coding agents over MCP. These pages cover the model, how to wire it into your agent, how the GitHub Action populates the index, and how to surface contract drift on pull requests. Sign in with GitHub at app.carrick.tools to get started — there is no API key to create or store: scans authenticate through the GitHub App and Actions OIDC, and your agent signs in through the browser. See the Quickstart.

Get started

Introduction What Carrick is, what you can do with it, and how to connect your agent. Quickstart Sign in, install the GitHub App, connect your repos to a project, add the workflow, and run your first scan. What Carrick covers What Carrick scans, the requirements a repo needs to scan cleanly, the framework and protocol story, and the cases that fall outside MVP scope.

Guides

Connecting your agent Per-client MCP setup for Claude Code, Cursor, Windsurf, and Codex, including the OAuth consent flow and the manual token fallback. carrick.json Per-repo config that tells the scanner which services a repo contains and which env vars and domains name internal services versus third-party APIs. PR comments Carrick comments contract-drift findings on your pull requests, posted by the GitHub App — on by default, toggled per project.

Reference

MCP tools Reference for every tool and resource the Carrick MCP server exposes at api.carrick.tools/mcp.

For agents

Every page on this site is also served as raw markdown at the same path with a .md suffix. An index of all pages in the llms.txt format lives at /llms.txt. A full concatenated dump of every page lives at /llms-full.txt.

llms.txt llms-full.txt sitemap github marketing site