EventCatalog llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/eventcatalog/llms-txt) # EventCatalog llms.txt Browse EventCatalog documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. eventcatalog.dev/llms.txt [Raw llms.txt](https://eventcatalog.dev/llms.txt) [Raw llms-full.txt](https://eventcatalog.dev/llms-full.txt) Copy Markdown [](https://eventcatalog.dev/llms.txt) llms.txt about-us Building the Open Source Documentation Tool for Software Architecture blog Blog - EventCatalog Introducing diagrams as first-class resources Let tools find your APIs from one URL Integrate Apicurio Registry with EventCatalog Your architecture is changing. Do you know about it? Archive AsyncAPI integration with EventCatalog Introducing Authentication and SSR Mode Integrate Azure Schema Registry with EventCatalog EventCatalog now includes a built-in MCP server Giving your AI agents docs they can actually trust How to turn C4 diagrams into EventCatalog documentation Modelling more message patterns in EventCatalog Your catalog nodes now show what they actually are Add custom dashboards, tools, and APIs to EventCatalog Introducing Search v2 Document, visualize and discover your data products Document and Govern AI Agents in EventCatalog Documenting sync and async APIs with EventCatalog Document events at the domain level Amazon EventBridge integration with EventCatalog 2.13.0 2.5.0 Whats new in EventCatalog - April 2025 Introducing Attachments for EventCatalog EventCatalog August 2024 update Whats new in EventCatalog - August 2025 Announcing Changelogs for EventCatalog Introducing EventCatalog Chat Access your EventCatalog from the command line Introducing EventCatalog Cloud and Plugin Licensing Introducing Custom Components Introducing EventCatalog Custom Documentation EventCatalog December 2024 update Bring your diagrams to EventCatalog Introducing EventCatalog Directory Edit your EventCatalog without opening Markdown EventCatalog February 2025 update Introducing EventCatalog Federation Embed IcePanel Diagrams in EventCatalog What's new in EventCatalog - January 2026 Whats new in EventCatalog - July 2025 Whats new in EventCatalog - June 2025 Introducing the EventCatalog Linter EventCatalog March 2025 update Whats new in EventCatalog - March 2026 Whats new in EventCatalog - May 2025 Whats new in EventCatalog - May 2026 Introducing EventCatalog MCP Server Bring Your Miro Boards to Life in EventCatalog Your documentation is a design artifact, not just a wiki page EventCatalog November 2024 update EventCatalog October 2024 update Whats new in EventCatalog - October 2025 EventCatalog now integrates with OpenAI Announcing the new EventCatalog SDK EventCatalog September 2024 update Whats new in EventCatalog - September 2025 Introducing Themes and Dark Mode Introducing EventCatalog v2 Introducing EventCatalog v3 Introducing EventCatalog v4 Model external systems in EventCatalog Which fields are your consumers actually using? Flows now support containers and data products Describe the workflow, let the agent build the flow Click any node to explore its connections in Focus Mode Introducing the EventCatalog GitHub Action Using GitHub as a schema registry with EventCatalog Introducing GraphQL integration with EventCatalog Full-content search comes to EventCatalog Your architecture decisions belong next to your architecture Introducing Data Stores with EventCatalog Introducing Entity Maps Introducing EventCatalog Reports Introducing query messages for EventCatalog Bring live data into EventCatalog Live data meets architecture documentation Document examples with your schemas Document who consumes your APIs, not just who owns them OpenAPI integration with EventCatalog Write docs once, serve both humans and AI agents Introducing Remote Schemas - Fetch and Sync Schemas at Runtime The right documentation, in the right place EventCatalog 2.64.0 - Schemas! Trace every field across your schemas and architecture EventCatalog Slack integration Sync users and teams from GitHub into EventCatalog Tags One post tagged with "2" One post tagged with "ADRs" 2 posts tagged with "Agents" 11 posts tagged with "AI" One post tagged with "API Discovery" One post tagged with "API Documentation" One post tagged with "API Integration" One post tagged with "Apicurio" 6 posts tagged with "Architecture" One post tagged with "Assistant" One post tagged with "Astro" 2 posts tagged with "AsyncAPI" One post tagged with "Attachments" One post tagged with "August" One post tagged with "Authentication" One post tagged with "Automation" One post tagged with "Azure" One post tagged with "Beta" 2 posts tagged with "C4" One post tagged with "Change Detection" One post tagged with "Changelogs" 2 posts tagged with "Channels" One post tagged with "CI/CD" One post tagged with "Claude Code" One post tagged with "CLI" One post tagged with "commands" 3 posts tagged with "Component" 2 posts tagged with "Components" One post tagged with "Cursor" One post tagged with "Custom Components" One post tagged with "Custom Tools" 2 posts tagged with "Customization" 2 posts tagged with "Dark Mode" One post tagged with "Data" One post tagged with "Data Products" One post tagged with "DDD" One post tagged with "Design" One post tagged with "diagrams" One post tagged with "Distributed System" 6 posts tagged with "Documentation" One post tagged with "Domain-Driven Design" One post tagged with "domains" One post tagged with "Draw.io" One post tagged with "EDA" One post tagged with "Editor" One post tagged with "Entity Maps" One post tagged with "EventBridge" 87 posts tagged with "EventCatalog" One post tagged with "Event-Driven Architecture" One post tagged with "Event Hubs" 3 posts tagged with "Events" One post tagged with "Examples" One post tagged with "Features" One post tagged with "Field Intelligence" One post tagged with "Field Usage" 3 posts tagged with "Flows" One post tagged with "Focus Mode" One post tagged with "Generators" One post tagged with "GitHub" 2 posts tagged with "Governance" One post tagged with "GraphQL" One post tagged with "IcePanel" One post tagged with "Icons" One post tagged with "Integration" One post tagged with "Integrations" One post tagged with "January" One post tagged with "July" One post tagged with "June" 2 posts tagged with "Layout" One post tagged with "Linter" One post tagged with "Lucid" One post tagged with "March" One post tagged with "May" 2 posts tagged with "MCP" One post tagged with "MDX" 2 posts tagged with "Messages" 3 posts tagged with "Miro" One post tagged with "October" One post tagged with "OpenAI" 3 posts tagged with "OpenAPI" One post tagged with "Ownership" One post tagged with "Quality" One post tagged with "Queries" One post tagged with "Remote Schema" One post tagged with "Reports" 3 posts tagged with "Scale" 3 posts tagged with "Schema" One post tagged with "Schema Explorer" 2 posts tagged with "Schema Registry" 2 posts tagged with "SDK" 2 posts tagged with "Search" One post tagged with "September" 4 posts tagged with "Services" One post tagged with "Skills" One post tagged with "Slack" One post tagged with "SSR" One post tagged with "Static Sites" One post tagged with "Teams" One post tagged with "Themes" 26 posts tagged with "Update" One post tagged with "User Experience" One post tagged with "v3.36.0" One post tagged with "v3.36.3" One post tagged with "versioning" 2 posts tagged with "Visualiser" One post tagged with "Visualization" 3 posts tagged with "Visualizer" See your architecture clearly: Major visualizer improvements Rearrange and save your visualizer layouts blog-2 Blog - EventCatalog Let tools find your APIs from one URL Integrate Apicurio Registry with EventCatalog Your architecture is changing. Do you know about it? AsyncAPI integration with EventCatalog Introducing Authentication and SSR Mode Integrate Azure Schema Registry with EventCatalog EventCatalog now includes a built-in MCP server Giving your AI agents docs they can actually trust How to turn C4 diagrams into EventCatalog documentation Modelling more message patterns in EventCatalog Your catalog nodes now show what they actually are Add custom dashboards, tools, and APIs to EventCatalog Introducing Search v2 Document, visualize and discover your data products Introducing diagrams as first-class resources Document and Govern AI Agents in EventCatalog Documenting sync and async APIs with EventCatalog Document events at the domain level Amazon EventBridge integration with EventCatalog 2.13.0 2.5.0 Whats new in EventCatalog - April 2025 Introducing Attachments for EventCatalog EventCatalog August 2024 update Whats new in EventCatalog - August 2025 Announcing Changelogs for EventCatalog Introducing EventCatalog Chat Access your EventCatalog from the command line Introducing Custom Components Introducing EventCatalog Custom Documentation Bring your diagrams to EventCatalog Edit your EventCatalog without opening Markdown EventCatalog February 2025 update Introducing EventCatalog Federation Embed IcePanel Diagrams in EventCatalog What's new in EventCatalog - January 2026 Whats new in EventCatalog - July 2025 Whats new in EventCatalog - June 2025 Introducing the EventCatalog Linter EventCatalog March 2025 update Whats new in EventCatalog - March 2026 Whats new in EventCatalog - May 2025 Whats new in EventCatalog - May 2026 Introducing EventCatalog MCP Server Bring Your Miro Boards to Life in EventCatalog Your documentation is a design artifact, not just a wiki page EventCatalog November 2024 update EventCatalog October 2024 update Whats new in EventCatalog - October 2025 EventCatalog now integrates with OpenAI Announcing the new EventCatalog SDK EventCatalog September 2024 update Whats new in EventCatalog - September 2025 Introducing Themes and Dark Mode Introducing EventCatalog v2 Introducing EventCatalog v3 Introducing EventCatalog v4 Model external systems in EventCatalog Which fields are your consumers actually using? Flows now support containers and data products Describe the workflow, let the agent build the flow Click any node to explore its connections in Focus Mode Introducing the EventCatalog GitHub Action Full-content search comes to EventCatalog Your architecture decisions belong next to your architecture Introducing Data Stores with EventCatalog Introducing Entity Maps Introducing EventCatalog Reports Introducing query messages for EventCatalog Bring live data into EventCatalog Live data meets architecture documentation Document examples with your schemas Document who consumes your APIs, not just who owns them Write docs once, serve both humans and AI agents Introducing Remote Schemas - Fetch and Sync Schemas at Runtime The right documentation, in the right place EventCatalog 2.64.0 - Schemas! Trace every field across your schemas and architecture EventCatalog Slack integration Sync users and teams from GitHub into EventCatalog See your architecture clearly: Major visualizer improvements Rearrange and save your visualizer layouts book-demo Get in touch changelog Changelog code-of-conduct tODO contact-us Contact Us enterprise EventCatalog Enterprise Support features Bring your own models to find the information you need in seconds, not days. Go from documentation to design Track changes across your architecture Documentation designed for software, not generic wikis. Ask your architectureanything. See your system as it actually works. federation EventCatalog for Enterprise index%20copy Page Not Found integrations Integrate with your tools Amazon API Gateway Amazon EventBridge Apicurio Registry AsyncAPI Atlassian Compass AWS Glue Schema Registry Azure Schema Registry Backstage Claude Desktop Confluent Schema Registry Cursor DrawIO FigJam GitHub GraphQL Hookdeck integration IcePanel LikeC4 Lucid Microsoft Entra ID Miro Discoverability forIntegrate with your systems using OpenAPI Windsurf landing-page-v1 Know what exists.Know who owns it.Know how it connects. landing-page-v2 The architecture knowledge base for engineering teams learn Start documenting with EventCatalog new-page Discover every event.Understand everything.Build with confidence. newsletter Email Sign Up - EventCatalog page-3 Know what exists.Know who owns it.Know how it connects. page-openai Know what exists.Know who owns it.Know how it connects. pricing Pricing - EventCatalog Small Business Program - EventCatalog pricing-2 Pricing - EventCatalog privacy Privacy Policy product Architecture documentation for your teams search Search the documentation services2 EventCatalog Professional Services specifications Discoverability forYour central hub for support Help fix discoverability Sponsor our project terms Terms of Service use-cases Common patterns with EventCatalog Context for AI engineering AI/LLM Context Foundation Architecture Documentation Architecture Planning Automated catalog Automated Documentation Not Just an API Documentation Tool Breaking Change Detection CI/CD Integration Custom governance workflows Domain-Driven Design Documentation Federated catalog Enrich Schemas with Documentation A shared understanding across the organization Single catalog workshops De-Risk Your EDA. Scale with Confidence. docs Amazon API Gateway Amazon EventBridge Code blocks eventcatalog.config.js EventCatalog CLI Apicurio Registry Ask your architecture AsyncAPI AWS Glue Schema Registry Azure Schema Registry Backstage Bring your own documentation Diagrams Contributing to the Miro App EventCatalog Studio Documentation EventCatalog Studio Documentation Editor explanation EventCatalog Studio Documentation Getting Started with the Miro App Miro App Guides Editor how-to guides Import OpenAPI & AsyncAPI into Miro EventCatalog Studio Documentation EventCatalog Studio Documentation Editor reference Using AI with the Miro App Changelogs EventCatalog CLI Channels CLI Commands Commands CLI Commands Custom Docs CLI Commands Data Products CLI Commands Data Stores CLI Commands Diagrams CLI Commands Domains CLI Commands Entities CLI Commands Events CLI Commands Export CLI Commands Governance CLI Commands Import CLI Commands Messages CLI Commands Queries CLI Commands Services CLI Commands Snapshots CLI Commands Teams CLI Commands Users CLI Commands Utilities CLI Commands Components Write your own components Diagrams Components Confluent Schema Registry Contributing to EventCatalog Customize Visualizer Developer tools EventCatalog Skills EventCatalog Docs llms.txt EventCatalog Docs llms-full.txt EventCatalog Agents Breaking Changes Agent Code-to-Docs Agent EventCatalog Agents Custom Tools Configuration What is EventCatalog Assistant? AI with EventCatalog LLMS.txt Getting started MCP server schemas.txt Skills Installing AI Skills AI Skills Slack Integration Deployment Installation Slack integration Slack app setup Troubleshooting Using the bot Enabling authentication Authentication Guide Providers Setting up Auth0 Setting up Azure AD (Entra ID) Setting up GitHub Setting up Google Setting up Okta Role-Based Access Control (RBAC) Middleware Adding high level documentation Components Introduction Adding custom page owners Comparing diagram versions Create a diagram What are diagrams? Diagrams reference Add diagrams to resources Bring your own documentation Adding resource-level documentation Configure categories Resource-level documentation Version documents Accordion AccordionGroup Admonitions AgentTools Attachments ChannelInformation CustomProperties Design EntityMap Flow Link MermaidFileLoader MessageTable NodeGraph OpenAPI Prompt RemoteSchema ResourceGroupTable ResourceLink Schema SchemaViewer Steps Tabs Tiles Visibility Add client-side scripts Create your first component Fetch data in components Write your own components Pass data into components Custom components reference Style components Using IcePanel Using LikeC4 Using mermaid Using PlantUML Using Structurizr Resource references Reusable snippets Using components Customization Documentation Application Sidebar Custom pages and API routes Create a custom page Create an API route Custom pages and API routes Custom pages and API routes reference Custom properties on resources Customize landing page Customize tables Customize visualizer nodes Documentation sidebar Resource icons Search Themes Deployment guides Building Eventcatalog Building Eventcatalog Deployment Workflows Hosting Embed Designs into EventCatalog Further Reading Import Resources into Studio Documentation to Design api-catalog EventCatalog Linter MCP Server Getting Started Documentation Configuration Develop and build Fundamentals Installation Why EventCatalog? Project structure CLI & CI/CD Configuration Architecture Change Detection Pipeline gates Recipes Webhook Payload Adding Analytics Authentication Creating changelogs Automated diffs Understanding changelogs Changelogs reference Add a changelog Add data products to domains Add entities to domains Add messages to domains Add services to domains Add systems to domains Create a domain What are domains? Model subdomains Ubiquitous language Adding domain owners Domains reference Version domains Domain integration map EventCatalog Assistant Automated teams and users Create a team Create a user Create your own connector Sync from GitHub Sync from Microsoft Entra ID Teams reference Users reference What are teams & users? Create an ADR What are architecture decision records? Add ADRs to resources Architecture decision records reference Model ADR relationships Adding data stores to agents Adding messages to agents Add tools to agents Create an agent Understanding agents Model metadata Agents reference Create a data product Data Contracts Inputs and outputs Understanding data products Data products reference Add read/write relationships Create a data store Understanding data stores Data stores reference Add entities to resources Create an entity Entity maps What are entities? Model entity relationships Entities reference Add flows to resources Create a flow Understanding flows Model flow steps Flows reference Add usage examples Group messages Map commands to events Map producers and consumers Patterns for shared messages Create a command Create a draft message Create an event Create a query Creating channels Routing messages through channels Understanding channels Message channels reference Commands Events Queries Messages reference Add a changelog Deprecate messages Version messages What are messages? Add schemas to data stores Add schemas to messages Add AsyncAPI specifications Add GraphQL schemas Add OpenAPI specifications Consumer Field Usage Fields Explorer Schema Explorer Schemas reference Schema API Schema MCP What are schemas and specifications? Add data stores to services Add entities to services Add messages to services Create an external service Create a service Understanding services Add service owners Use components Services reference Add a changelog Deprecate services Version services Add resources to systems Create a system What are systems? Model relationships and actors Systems reference System context maps Versioning resources License Keys Getting a license key for integrations How license validation works License Keys Overview Getting a license key for EventCatalog Scale Upgrading EventCatalog Upgrade to EventCatalog v2 Upgrade to EventCatalog v3 Upgrade to EventCatalog v4 Domains Add resources to domains Visualize domains Beta status and feedback How EventCatalog Editor works Editor, Markdown, MDX, and Git Make your first edit with EventCatalog Editor Add schemas and specifications Edit an EventCatalog resource Invite editors to your organization Open a catalog in the editor Preview editor changes Revert local editor changes Review and publish editor changes Run EventCatalog Editor locally Use the Flow Editor Use slash commands EventCatalog Editor EventCatalog Editor CLI reference Supported content and MDX Supported resources Troubleshooting EventCatalog Editor EventCatalog Federation GitHub GraphQL Documenting your architecture High level documentation Resource-level documentation Hookdeck Connect messages Create messages Message Channels Message types Versioning & lifecycle Adding Resources to the Board Import AsyncAPI into Miro Connected Resources Connecting to EventCatalog Creating New Resources Editing Resources Exporting to EventCatalog Getting Involved Installing the Miro App Navigating the Board Import OpenAPI into Miro EventCatalog Miro App Import from Schema Registries Services and Dependencies From Miro to EventCatalog with AI OpenAPI Teams & Users Ownership & language All EventCatalog plugins Examples Features Installation Getting started Plugin Configuration Examples Features Installation Introduction Plugin Configuration Workflows Examples Features Installation Introduction Plugin Configuration Using reference objects Installation API Reference Examples Features Getting started Examples Features Installation Introduction Plugin Configuration Backstage configuration Examples Installation Getting started Examples Features Installation Introduction Plugin Configuration Workflows Generator API Examples Features Installation Getting started Setup main catalog Examples Installation Introduction Plugin Configuration Configuring team catalogs Generators Examples Features Installation Introduction Plugin Configuration Examples Features Installation Introduction Plugin Configuration Hookdeck Generator API Hookdeck Generator CLI Getting started Understanding EventCatalog Plugins Workflows Examples Features Installation Getting started Plugin Configuration Resources Architecture Decision Records Agents Data Stores Data Products Entities Flows Messages Schemas & Specifications Services Add specifications to services Explore schemas @eventcatalog/sdk Class: FlowBuilder Function: addAgentToDomain() Function: addContainerToSystem() Function: addDataProductToDomain() Function: addDataStoreToAgent() Function: addDataStoreToService() Function: addEntityToDomain() Function: addEntityToService() Function: addEntityToSystem() Function: addExampleToCommand() Function: addExampleToEvent() Function: addExampleToQuery() Function: addFileToAdr() Function: addFileToAgent() Function: addFileToCommand() Function: addFileToDataProduct() Function: addFileToDataStore() Function: addFileToDiagram() Function: addFileToDomain() Function: addFileToEvent() Function: addFileToFlow() Function: addFileToQuery() Function: addFileToService() Function: addFileToSystem() Function: addFlowToAgent() Function: addFlowToSystem() Function: addMessageToAgent() Function: addMessageToChannel() Function: addMessageToDomain() Function: addMessageToService() Function: addResourceToSystem() Function: addSchemaToCommand() Function: addSchemaToEvent() Function: addSchemaToQuery() Function: addServiceToDomain() Function: addServiceToSystem() Function: addSubDomainToDomain() Function: addSystemToDomain() Function: addUbiquitousLanguageToDomain() Function: adrHasVersion() Function: agentHasVersion() Function: appendChangelog() Function: channelHasVersion() Function: commandHasVersion() Function: dataProductHasVersion() Function: dataStoreHasVersion() Function: diagramHasVersion() Function: domainHasVersion() Function: dumpCatalog() Function: entityHasVersion() Function: eventHasVersion() Function: flowHasVersion() Function: getAdr() Function: getAdrs() Function: getAgent() Function: getAgentByPath() Function: getAgents() Function: getChangelog() Function: getChannel() Function: getChannels() Function: getCommand() Function: getCommands() Function: getConsumersOfSchema() Function: getCustomDoc() Function: getCustomDocs() Function: getDataProduct() Function: getDataProducts() Function: getDataStore() Function: getDataStores() Function: getDiagram() Function: getDiagrams() Function: getDomain() Function: getDomains() Function: getEntities() Function: getEntity() Function: getEvent() Function: getEventCatalogConfigurationFile() Function: getEvents() Function: getExamplesFromCommand() Function: getExamplesFromEvent() Function: getExamplesFromQuery() Function: getFlow() Function: getFlows() Function: getMessageBySchemaPath() Function: getOwnersForResource() Function: getProducersAndConsumersForMessage() Function: getProducersOfSchema() Function: getQueries() Function: getQuery() Function: getSchemaForMessage() Function: getService() Function: getServiceByPath() Function: getServices() Function: getSpecificationFilesForService() Function: getSystem() Function: getSystemByPath() Function: getSystems() Function: getTeam() Function: getTeams() Function: getUbiquitousLanguageFromDomain() Function: getUser() Function: getUsers() Function: isAgent() Function: isService() Function: isSystem() Function: queryHasVersion() Function: removeExampleFromCommand() Function: removeExampleFromEvent() Function: removeExampleFromQuery() Function: rmAdr() Function: rmAdrById() Function: rmAgent() Function: rmAgentById() Function: rmChangelog() Function: rmChannel() Function: rmChannelById() Function: rmCommand() Function: rmCommandById() Function: rmCustomDoc() Function: rmDataProduct() Function: rmDataProductById() Function: rmDataStore() Function: rmDataStoreById() Function: rmDiagram() Function: rmDiagramById() Function: rmDomain() Function: rmDomainById() Function: rmEntity() Function: rmEntityById() Function: rmEvent() Function: rmEventById() Function: rmFlow() Function: rmFlowById() Function: rmQuery() Function: rmQueryById() Function: rmService() Function: rmServiceById() Function: rmSystem() Function: rmSystemById() Function: rmTeamById() Function: rmUserById() Function: serviceHasVersion() Function: systemHasVersion() Function: toAgent() Function: toService() Function: toSystem() Function: versionAdr() Function: versionAgent() Function: versionChannel() Function: versionCommand() Function: versionDataProduct() Function: versionDataStore() Function: versionDiagram() Function: versionDomain() Function: versionEntity() Function: versionEvent() Function: versionFlow() Function: versionQuery() Function: versionService() Function: versionSystem() Function: writeAdr() Function: writeAgent() Function: writeAgentToDomain() Function: writeChangelog() Function: writeChannel() Function: writeCommand() Function: writeCommandToAgent() Function: writeCommandToService() Function: writeCustomDoc() Function: writeDataProduct() Function: writeDataProductToDomain() Function: writeDataStore() Function: writeDataStoreToService() Function: writeDataStoreToSystem() Function: writeDiagram() Function: writeDomain() Function: writeEntity() Function: writeEntityToSystem() Function: writeEvent() Function: writeEventToAgent() Function: writeEventToService() Function: writeFlow() Function: writeFlowToAgent() Function: writeFlowToDomain() Function: writeFlowToService() Function: writeFlowToSystem() Function: writeQuery() Function: writeQueryToAgent() Function: writeQueryToService() Function: writeService() Function: writeServiceToDomain() Function: writeServiceToSystem() Function: writeSystem() Function: writeSystemToDomain() Function: writeTeam() Function: writeUser() Function: writeVersionedAgent() Function: writeVersionedFlow() Function: writeVersionedService() Type Alias: FlowActorStepInput Type Alias: FlowAgentStepInput Type Alias: FlowBuilderInput Type Alias: FlowCustomStepInput Type Alias: FlowDataProductStepInput Type Alias: FlowDataStoreStepInput Type Alias: FlowExternalSystemStepInput Type Alias: FlowMessageStepInput Type Alias: FlowServiceStepInput Type Alias: FlowStepInput Type Alias: FlowSubFlowStepInput Add resources to services Ownership & components Versioning & lifecycle Starting a new project Adding comments Adding documentation Deleting designs Export as prompt Embed into EventCatalog Import EventCatalog resources Import & Export Reset your environment Templates Using nodes Version Control & Audits Self-host Getting Started Managing your organization Organization settings Upgrade to a paid plan Contributing Open Source Roadmap Welcome to EventCatalog Studio Why EventCatalog Studio? Systems Introduction Add ownership Build and deploy your catalog Consume the event from a service Create a domain Create a service Create an event Install EventCatalog Next steps Publish the event from a service Visualize your catalog ## What is EventCatalog's llms.txt? EventCatalog publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what EventCatalog offers and where to find details. Issues Spec 31 Sections 1047 Links 166.7 KB Size ~42.7k Tokens Sections: about-us · blog · blog-2 · book-demo · changelog · code-of-conduct · and 25 more ## Add EventCatalog Docs to Your AI Assistant Select your tool to see how to add EventCatalog's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://eventcatalog.dev/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about EventCatalog Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 261 errors ## Frequently Asked Questions Where is EventCatalog's llms.txt file? EventCatalog publishes its llms.txt at https://eventcatalog.dev/llms.txt. This file provides a structured, markdown-formatted index of EventCatalog's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use EventCatalog's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of EventCatalog's documentation so it can provide better code suggestions and answers about EventCatalog. What does EventCatalog's llms.txt contain? EventCatalog's llms.txt contains 31 sections and 1047 documentation links in 166.7 KB (~42.7k tokens). Key sections include about-us, blog, blog-2, book-demo, changelog, code-of-conduct. How many tokens does EventCatalog's llms.txt use? The concise llms.txt index is approximately 42.7k tokens (166.7 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is EventCatalog? EventCatalog is an Open Source project that helps you document your messages, services and domains.. EventCatalog's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with EventCatalog. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Tamagui Complete Documentation Tamagui is a complete UI solution for React Native and Web, with a fully-featured UI kit, styling engine, and optimizing compiler.](https://mdream.dev/llms-txt/eventcatalog/llms-txt/tamagui) [Nx Nx is an AI-first monorepo platform that connects your editor to CI. It helps you deliver fast without breaking things by optimizing builds, scaling CI, and fixing failed PRs.](https://mdream.dev/llms-txt/eventcatalog/llms-txt/nx) [Baeldung on Ops](https://mdream.dev/llms-txt/eventcatalog/llms-txt/baeldung-on-ops) [The JavaScript Oxidation Compiler The JavaScript Oxidation Compiler](https://mdream.dev/llms-txt/eventcatalog/llms-txt/oxc) [openmediavault](https://mdream.dev/llms-txt/eventcatalog/llms-txt/openmediavault) [GitBook Documentation](https://mdream.dev/llms-txt/eventcatalog/llms-txt/gitbook) [Nylas | Powerful Communication APIs Unlock the power of your communications data. The Nylas communication APIs remove complexity & empower teams to create seamless user experiences.](https://mdream.dev/llms-txt/eventcatalog/llms-txt/nylas-mail) [Appwrite Appwrite® - complete cloud infrastructure for your web, mobile and AI apps. Including Auth, Databases, Storage, Functions, Messaging, Hosting, Realtime and more](https://mdream.dev/llms-txt/eventcatalog/llms-txt/appwrite) [View all 99 projects ](https://mdream.dev/llms-txt/eventcatalog/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/eventcatalog/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/eventcatalog/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)