aide

Agent Readiness for Docs Sites

If you build developer tools, libraries, or APIs, AI agents are your most active readers.

Here are the 5 highest-leverage fixes you can make today to ensure LLMs correctly ingest and synthesize your documentation:

1. Publish llms.txt

The fastest way to onboard an agent is to provide a map. Publish /llms.txt listing your core guides, and /llms-full.txt concatenating your entire manual.

2. Markdown Negotiation

When an agent requests Accept: text/markdown, serve raw MDX instead of a bloated React DOM.

3. Link Headers

Don't make agents parse HTML to find your OpenAPI spec. Put it in an HTTP Link header on your homepage.

4. OpenAPI Discovery

Host your OpenAPI YAML file where agents can find it, and link it via /.well-known/api-catalog.

5. Web Bot Auth

If you run an agent that interacts with user APIs, publish your keys so servers can trust your bot's signature.