Skip to main content

AI Skills

EventCatalog Skills are pre-built instructions that teach AI agents how to work with your EventCatalog project. Install a skill and your AI agent gains the ability to generate correct documentation, following EventCatalog conventions and best practices.

Skills work with any AI coding agent that supports the skills format (e.g. Claude Code).

Why use skills?​

When you ask an AI agent to generate EventCatalog documentation, it doesn't know about EventCatalog's frontmatter format, folder structure, or component conventions. Skills solve this by providing the agent with structured instructions and reference material.

With skills installed, you can ask your agent things like:

  • "Document my OrderService that receives OrderCreated events and sends OrderConfirmed events"
  • "Create a Payments domain with a PaymentService, PaymentProcessed event, and ProcessPayment command"
  • "Look at my src/ directory and generate EventCatalog documentation for the services and events you find"
  • "Document the checkout flow from cart submission through payment processing to order confirmation"

The agent will generate properly formatted index.mdx files with correct frontmatter, schemas, and visualizations.

Available skills​

SkillDescription
Catalog Documentation CreatorGenerates EventCatalog documentation files (services, events, commands, queries, domains, flows, channels, containers) with correct frontmatter, folder structure, and best practices.

Getting started​

Head to the installation guide to add skills to your project.

Source code: github.com/event-catalog/skills