Index your docs for your product's agents

Write a compact index of your docs into your product’s AGENTS.md, so the agents of the people who use your product read them.

For AI agents: the documentation index is at llms.txt, and this page is available as Markdown.

The agents that write your docs read AGENTS.md and the skill. The agents of the people who use your product read your docs too, and ascribe agents index writes something for those: a compact index of the docs, one line a page, small enough to go in your product’s own AGENTS.md. With --pages, it also copies each page’s Markdown version into a folder, and the index points into it, so a package can ship the docs for the version it installs, with no server and nothing to fetch.

Write the index

Write the index into your product’s AGENTS.md, and the pages beside it:
```
ascribe agents index --build site --into packages/sdk/AGENTS.md --pages packages/sdk/docs
```
It writes between markers, as sync does, so you keep the rest of the file. Its pages come as llms.txt’s do, in the navigation’s order.
Above the markers, write what the agent should do with it. Vercel’s version said “Prefer retrieval-led reasoning over pre-training-led reasoning”.
Run the command again in CI or before a release: it replaces only the index.

ascribe agents index has each option, and what the index leaves out to stay under its limit.

Is it worth it

The evidence for it is one vendor’s. Vercel put an index of about 8 KB, of paths to local docs files, in AGENTS.md, and its evals on Next.js APIs newer than its model’s training passed 100% of the time, against 53% with no docs; a skill that offered the same docs wasn’t used in 56% of cases (Vercel). It’s one framework, on evals whose number and model weren’t published, and nobody has repeated it. The reason it makes sense is simpler than the number: an agent uses what’s in front of it, and an index in AGENTS.md always is.