LLMS.txt

Added in eventcatalog@2.20.0

Enable tools like Claude, ChatGPT, GitHub Copilot, and Cursor to quickly understand your EventCatalog.

What is LLMS.txt?

LLMS.txt is a proposed standard that helps AI-powered development tools better understand and interact with your documentation. Similar to how robots.txt guides web crawlers, LLMS.txt provides structured information that makes it easier for AI assistants like Claude, ChatGPT, and GitHub Copilot to process your EventCatalog documentation.

The file is automatically generated and maintained as part of your documentation pipeline, requiring no manual configuration. It organizes your documentation's key concepts, structures, and relationships in a format optimized for machine reading.

llms.txt and llms-full.txt

The llms.txt file includes your EventCatalog resources in a simple format. Lists your resources with a summary for each of them.

The llms-full.txt file includes your EventCatalog resources in a more detailed format. All the contents of your Catalog resources are included in the file.

Enable in EventCatalog

llms.txt is disabled by default. You can enable it by turning it on in your eventcatalog.config.js file.

eventcatalog.config.js

llms: {
    enabled: true,
},

Once you enable llms.txt you can query both the urls:

• https://<your-catalog-url>/docs/llm/llms.txt
  • Demo: https://demo.eventcatalog.dev/docs/llm/llms.txt
• https://<your-catalog-url>/docs/llm/llms-full.txt
  • Demo: https://demo.eventcatalog.dev/docs/llm/llms-full.txt

How to use LLMS.txt?

Once you deploy your EventCatalog you can use your tools to ask questions about your Catalog.