> For the complete documentation index, see [llms.txt](https://ascribed-dev.com/docs/llms.txt). This documentation describes Ascribe 0.4.4. Anything marked in main, not yet released isn't in that release yet.

# Agents

> How-to · Working on an Ascribe project with an AI coding agent, such as Claude Code, GitHub Copilot, or Cursor, and handing it the problems Ascribe finds.

An [agent](https://ascribed-dev.com/docs/glossary.md#agent) is the AI coding tool you work with: Claude Code, GitHub Copilot, Cursor, Codex, and others. Ascribe gives your agent what it knows about a project, in a form an agent reads well, and checks what the agent writes. Its tools answer questions and return edits; your agent makes them, with your approvals.

Nothing here is set up until you run a command for it. The quickest start, in a project's folder:

```shell
ascribe agents sync
```

That writes `AGENTS.md` and the skill, which most agents read on their own. Then add what your agent can use:

- [Work with an agent](https://ascribed-dev.com/docs/agents/loop.md): the loop of editing a page and checking it, and the commands that answer what an agent would otherwise guess.
- [Write the agent files](https://ascribed-dev.com/docs/agents/instructions.md): your project's rules in `AGENTS.md`, and the skill that teaches the loop.
- [Prompt your agent](https://ascribed-dev.com/docs/agents/prompts.md): **Prompt agent** on a problem, a review comment, or a changed page.
- [Set up the MCP server](https://ascribed-dev.com/docs/agents/mcp.md): the same answers as tools, for an agent without a shell.
- [Check an agent's edits with hooks](https://ascribed-dev.com/docs/agents/hooks.md): a check it can't forget, after each edit and before it finishes.
- [Claude Code](https://ascribed-dev.com/docs/agents/claude-code.md) and [GitHub Copilot](https://ascribed-dev.com/docs/agents/copilot.md): what each needs beyond the rest. In VS Code, the extension sets up most of it: see [Agents in the editor](https://ascribed-dev.com/docs/editor/agents.md).
- [Index your docs for your product's agents](https://ascribed-dev.com/docs/agents/product-index.md): for the agents of the people who use your product, not the ones that write your docs.

[What's sent where](https://ascribed-dev.com/docs/agents/whats-sent.md) says what leaves your machine, and what to watch for when your agent reads someone else's text.

This guide writes commands as `ascribe`. With `@ascribed/cli` installed in your project, as [Install](https://ascribed-dev.com/docs/install.md#in-a-project-with-npm) says, run them as `npx ascribe` (`pnpm exec ascribe` with pnpm). The files `sync` writes tell your agent to do the same: see [The command they name](https://ascribed-dev.com/docs/agents/instructions.md#the-command-they-name).
