# Documentation Index

Use this page as the map of the written documentation.

## Start Here

| Audience                | Read This First                          | Then                                                                                                         |
| ----------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| New user                | [../README.md](../README.md)             | [starting-the-mcp.md](starting-the-mcp.md), [architecture.md](architecture.md)                               |
| New developer           | [../CONTRIBUTING.md](../CONTRIBUTING.md) | [DEVELOPERS.md](DEVELOPERS.md), [code-reference.md](code-reference.md)                                       |
| AI agent / MCP consumer | [../AGENTS.md](../AGENTS.md)             | [agents/getting-started.md](agents/getting-started.md), [mcp-resources-prompts.md](mcp-resources-prompts.md) |
| Tool/reference reader   | [tools/index.md](tools/index.md)         | [code-reference.md](code-reference.md), [errors/README.md](errors/README.md)                                 |

## Core Guides

| Document                                             | Purpose                                                                        |
| ---------------------------------------------------- | ------------------------------------------------------------------------------ |
| [starting-the-mcp.md](starting-the-mcp.md)           | Canonical install, startup, transport, verification, and troubleshooting guide |
| [architecture.md](architecture.md)                   | One long-running Lisp session model and major runtime boundaries               |
| [code-reference.md](code-reference.md)               | Source-level map of packages, scripts, tool categories, and tests              |
| [mcp-resources-prompts.md](mcp-resources-prompts.md) | MCP resources and prompt discoverability story                                 |
| [swank-integration.md](swank-integration.md)         | Swank-specific implementation details                                          |
| [protocol-handlers.md](protocol-handlers.md)         | JSON-RPC/MCP handler structure                                                 |

## Developer Guides

| Document                             | Purpose                                              |
| ------------------------------------ | ---------------------------------------------------- |
| [DEVELOPERS.md](DEVELOPERS.md)       | Where to change code and how subsystems fit together |
| [demo-creation.md](demo-creation.md) | Regenerating GIF demos                               |

## Reference Material

| Document                             | Purpose                          |
| ------------------------------------ | -------------------------------- |
| [tools/index.md](tools/index.md)     | Full per-tool reference index    |
| [errors/README.md](errors/README.md) | Error code and hint reference    |
| [agents/index.md](agents/index.md)   | Agent-oriented documentation hub |

## Operational Artifacts

| Path                           | Purpose                                                  |
| ------------------------------ | -------------------------------------------------------- |
| [`../examples/`](../examples/) | MCP client config examples and sample clients            |
| [`../scripts/`](../scripts/)   | Startup/debugging helpers                                |
| [`plans/`](plans/)             | Project planning artifacts already checked into the repo |
