LLMs.txt
How to get AI tools like Cursor, Windsurf, GitHub Copilot, ChatGPT, and Claude to understand Adonis Open Swagger Configuration & Usage, and best practices.
What is LLMs.txt?
LLMs.txt is a structured documentation format specifically designed for large language models (LLMs). Adonis Open Swagger provides LLMs.txt files that contain comprehensive information about our component library, making it easy for AI tools to understand and assist with Adonis Open Swagger development.
These files are optimized for AI consumption and contain structured information about configuration, usage, and others.
Available routes
We provide LLMs.txt routes to help AI tools access our documentation:
/llms.txt- Contains a structured overview of all components and their documentation links (~5K tokens)/llms-full.txt- Provides comprehensive documentation including implementation details, examples, theming, composables, and migration guidance (~1M+ tokens)
Choosing the Right File
Most users should start with /llms.txt - it contains all essential
information and works with standard LLM context windows. Use /llms-full.txt
only if you need comprehensive implementation examples and your AI tool
supports large contexts (200K+ tokens).
Important usage notes
@-symbol must be typed manually - When using tools like Cursor or
Windsurf, the @ symbol must be typed by hand in the chat interface.
Copy-pasting breaks the tool's ability to recognize it as a context reference.
Last updated on