# Carrick docs

> 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 the Model Context Protocol. These pages cover the model, the install flow, per-client agent setup, the scanner config, and the MCP tool reference.

## Get started

- [Introduction](https://docs.carrick.tools/introduction.md): What Carrick is, what you can do with it, and how to connect your agent.
- [Quickstart](https://docs.carrick.tools/quickstart.md): Sign in, install the GitHub Action, connect your agent over MCP, and run your first scan.
- [What Carrick covers](https://docs.carrick.tools/coverage.md): What Carrick scans, the requirements a repo needs to scan cleanly, the framework story, and the cases that fall outside MVP scope.

## Guides

- [Connecting your agent](https://docs.carrick.tools/connecting-your-agent.md): Per-client MCP setup for Claude Code, Cursor, Windsurf, and Codex, including the OAuth consent flow and the manual API-key fallback.
- [carrick.json](https://docs.carrick.tools/carrick-json.md): Per-repo config that tells the scanner which env vars and domains name internal services versus third-party APIs.
- [PR comments](https://docs.carrick.tools/pr-output.md): Carrick comments contract-drift findings on your pull requests, posted by the GitHub App and toggled per project.

## Reference

- [MCP tools](https://docs.carrick.tools/mcp-tools.md): Reference for every tool and resource the Carrick MCP server exposes at api.carrick.tools/mcp.

## Other

- [Full text of all guides](https://docs.carrick.tools/llms-full.txt)
- [Dashboard (install entry point)](https://app.carrick.tools)
- [Source code (scanner)](https://github.com/daveymoores/carrick)