# Carrick docs

> Carrick indexes TypeScript codebases across service and repository boundaries, tracing every route, type, and cross-service call and recording function behaviour so agents search by intent rather than name. It serves the index to AI agents over MCP and to IDEs over LSP, so they see existing endpoints and utilities before generating new code. 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, the four points where it answers, and where to start.
- [Quickstart](https://docs.carrick.tools/quickstart.md): Install the Carrick GitHub App on your repositories, let Carrick build the index, and connect your coding agent.
- [How Carrick works](https://docs.carrick.tools/how-it-works.md): The problem Carrick solves, the three layers of its index, where it answers, and the parts that build and serve the index.
- [What Carrick covers](https://docs.carrick.tools/coverage.md): 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

- [Building the index](https://docs.carrick.tools/building-the-index.md): How Carrick builds the index, rescanning a repository, scanning from your own machine, and the GitHub Actions workflow that keeps the index current.
- [In your editor](https://docs.carrick.tools/editor.md): Carrick editor diagnostics, cross-service go to definition, the code lens, the boundary line and one setting per surface.
- [Connecting your agent](https://docs.carrick.tools/connecting-your-agent.md): How coding agents read Carrick through local hooks, the hosted MCP index and editor diagnostics, with setup for each MCP client.
- [CLI](https://docs.carrick.tools/cli.md): Reference for Carrick login, workspace setup, the scan that builds the index, refreshes, file checks and status output.
- [carrick.json](https://docs.carrick.tools/carrick-json.md): 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](https://docs.carrick.tools/pr-output.md): Carrick comments contract-drift findings on your pull requests, posted by the GitHub App, on by default 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.

## Task skills

- [Task skills](https://docs.carrick.tools/task-skills.md): The four skills carrick init installs, how they arrive in both harnesses, the stamp that decides who owns each file, and the end-of-task nudge that points at one of them.
- [carrick-impact](https://docs.carrick.tools/carrick-impact.md): The task skill that lists everything that depends on the code you are about to change, with a file and line for each, and a type verdict for each consumer.
- [carrick-reuse](https://docs.carrick.tools/carrick-reuse.md): The task skill that compares the functions a task added against the whole function index, and groups the places a project has built the same thing twice.
- [carrick-drift](https://docs.carrick.tools/carrick-drift.md): The task skill that puts a producer's type, each consumer call site's expected type and the stored verdict side by side, one operation at a time.
- [carrick-census](https://docs.carrick.tools/carrick-census.md): The task skill for every-place-that-does-X questions: two wordings of one concept, paged to the end, joined into one list with a receipt.

## 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/carrick-tools/carrick)