# Kapelle

> Teams of coding agents in Firecracker microVMs, talking A2A over NATS. Written for people and for the agents that manage Kapelle for them.

- [Kapelle documentation](https://docs.yggdrasill.network/index.md): Where to start, and how this documentation is laid out.

## Start here

- [What is Kapelle](https://docs.yggdrasill.network/what-is-kapelle.md): What Kapelle is, what a team and a sandbox are, and which page to read for what you want to do.
- [Getting started](https://docs.yggdrasill.network/getting-started.md): From a fresh clone to a team answering a real task, every command run in order.
- [Console tour](https://docs.yggdrasill.network/console-tour.md): The pages of the Console and what each is for.
- [Onboard your agent](https://docs.yggdrasill.network/onboard-your-agent.md): Let your own coding agent manage Kapelle, with the token, the two-sentence prompt and the roles.

## For agents

- [Managing Kapelle through its API](https://docs.yggdrasill.network/agents.md): Start here if you are an agent managing a Kapelle deployment through its API; the conventions, safety rules, every route and the playbooks.

## Concepts

- [Teams](https://docs.yggdrasill.network/teams.md): What a team is, how it is created, how a work item flows through it, its budget, links and archive.
- [Agents and versions](https://docs.yggdrasill.network/agents-and-versions.md): What an agent holds, how an edit becomes a new version and which runs pick it up.
- [Team templates](https://docs.yggdrasill.network/templates.md): The blueprint a team is made from, field by field.
- [Runs](https://docs.yggdrasill.network/runs.md): A run's states, how to task a team, follow a run, answer it and cancel it.
- [Environments](https://docs.yggdrasill.network/environments.md): Sandbox profiles, providers, images, checkpoints and sleep.
- [Egress and destinations](https://docs.yggdrasill.network/egress-and-destinations.md): Which hosts an agent may reach, how credentials are injected, allowlist and allow-all.
- [Integrations](https://docs.yggdrasill.network/integrations.md): Connecting Mattermost, Slack, GitHub, Linear and Jira and linking teams to them.
- [Kapelle A2A Architecture](https://docs.yggdrasill.network/design.md): The architecture, the concepts (teams, roles, templates, runs, egress, memory) and the decisions behind them.
- [Team isolation (`isolation: shared` / `dedicated`)](https://docs.yggdrasill.network/team-isolation.md): Shared and dedicated isolation of a team's agents.
- [Context documents (`kapelle.controller.command`, `command: "context"`)](https://docs.yggdrasill.network/context-documents.md): Context documents an agent or a team gets in the guest, and their limits.
- [Skills (`kapelle.controller.command`, `command: "skills"`)](https://docs.yggdrasill.network/skills.md): Skills from the platform catalogue, a repository and a team, and how they are merged.
- [Team memory command (`kapelle.controller.command`, `command: "memory"`)](https://docs.yggdrasill.network/memory-commands.md): The team memory command and how runs use memory.
- [External MCP servers (`kapelle.controller.command`, `command: "mcp"`)](https://docs.yggdrasill.network/mcp.md): External MCP servers a team can use, how they are curated and where they are enforced.

## Reference

- [The Console API](https://docs.yggdrasill.network/console-api.md): The Console API's conventions, authentication, errors and routes.
- [OpenAPI contract](https://docs.yggdrasill.network/openapi.md): The OpenAPI contract, where to get it and how it is kept in step with the routes.
- [Command line](https://docs.yggdrasill.network/cli.md): The controller's command line and the just recipes around it.
- [Route reference](https://docs.yggdrasill.network/routes.md): Every route of the Console API by area, with the role it needs and its request and response shapes, generated from the OpenAPI document.
- [Playbooks](https://docs.yggdrasill.network/playbooks.md): Twelve things a person asks an agent to do with Kapelle, as the routes to call in order and what to check afterwards.
- [Limits](https://docs.yggdrasill.network/limits.md): The sizes, counts and durations the Console API enforces, read from the constants the code uses.

## Operate

- [Deployment](https://docs.yggdrasill.network/deployment.md): The control plane, the sandbox hosts and where each is set up.
- [Dev environment](https://docs.yggdrasill.network/dev-environment.md): The development stack, its services, profiles and every environment variable.
- [Upgrade runbook](https://docs.yggdrasill.network/upgrades.md): The upgrade runbook for every pinned component.
- [CI](https://docs.yggdrasill.network/ci.md): The CI workflows and what each job checks.
- [GitHub App: registration and token minting](https://docs.yggdrasill.network/github-app.md): Registering the GitHub App and how installation tokens are minted.
- [Slack App: registration and manifest](https://docs.yggdrasill.network/slack-app.md): Registering the Slack app and its manifest.
- [Linear agent app: registration](https://docs.yggdrasill.network/linear-app.md): Registering the Linear agent app.
- [Jira agent app: registration](https://docs.yggdrasill.network/jira-app.md): Registering the Jira agent app.
- [Eval results](https://docs.yggdrasill.network/eval-results.md): Results of the evaluation suite.

## Changelog

- [Changelog](https://docs.yggdrasill.network/changelog.md): What changed in each release, and what is not released yet.