Patterns
What breaks agent experience and how to fix it
Anti-Patterns
Best Practices
Your llms.txt is the first thing an agent reads about your product. It should describe what you do, what agents can do, and what you do not support. Update it when your product changes.
Place at your root URL. Follow the llms.txt spec. Include a limitations section. Add a changelog with ISO dates.
Every error is an opportunity to keep the agent moving. Typed codes, plain descriptions, and next-action guidance turn failures into recoverable events rather than dead ends.
Define a shared error schema across all endpoints. Include: code (string), message (string), retry (boolean), suggested_action (string). Document it as a public contract.
Browser-only OAuth is the single most common cause of agent abandonment. Tokens with explicit permission scopes let agents authenticate without visual browser interaction.
Add a token management screen to your dashboard. Support read-only, write, and admin scopes at minimum. Document the token endpoint in your llms.txt.
Schema.org markup gives AI platforms a reliable, structured source of truth about what your product is and who it serves.
Add SoftwareApplication or Product schema to your homepage. Include applicationCategory, description, and featureList properties. Validate with Google's Rich Results Test.
Agents build plans around your API's behaviour. Breaking changes without notice destroy those plans and erode trust.
Use semantic versioning. Include a version field in every response. Publish a public changelog. Provide a deprecation period of at minimum 90 days for breaking changes.