Skip to content

event-catalog/skills

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

EventCatalog AI Skills

A collection of AI agent skills for EventCatalog that help you document your architectures.

Contributions welcome! Run into a problem or have a question? Open an issue.

Available Skills

Skill Description
c4-to-eventcatalog Converts C4 architecture models (Structurizr DSL/JSON, C4-PlantUML, Mermaid C4, diagrams, or architecture descriptions) into an EventCatalog mapping plan, then hands off to catalog-documentation-creator to generate or update catalog files.
catalog-documentation-creator Generates EventCatalog documentation files (services, agents, events, commands, queries, domains, flows, channels, containers) with correct frontmatter, folder structure, and best practices.
code-to-catalog Scans a codebase, grills you interview-style on the architectural model (domains, services, agents, messages, boundaries), produces a plan file, then hands off to catalog-documentation-creator. Works for new catalogs and for reconciling existing catalogs with drifted code.
flow-wizard Interactive, conversational skill that guides you through documenting business and agent flows step-by-step, cross-referencing your existing catalog resources.

Installation

Option 1: CLI Install (Recommended)

Use npx skills to install skills directly:

# Install all skills
npx skills add event-catalog/skills

# Install a specific skill
npx skills add event-catalog/skills --skill catalog-documentation-creator

Option 2: Clone and Copy

Clone the entire repo and copy the skills you need:

git clone https://github.com/event-catalog/skills.git
cp -r eventcatalog-skills/skills/catalog-documentation-creator .claude/skills/

Option 3: Git Submodule

Add as a submodule for easy updates:

git submodule add https://github.com/event-catalog/skills.git .claude/skills/eventcatalog

Option 4: Fork and Customize

Fork the repo and tailor skills to your team's conventions:

  1. Fork this repository
  2. Modify skills to fit your needs
  3. Install from your fork:
    npx add-skill https://github.com/YOUR_ORG/eventcatalog-skills

Usage Examples

Once installed, the skills are automatically available to your AI agent. Here are some things you can ask:

Document a service:

"Document my OrderService that receives OrderCreated events and sends OrderConfirmed events"

Document an agent:

"Document my Order Support Agent that receives OrderCancelled events, reads the orders database, and uses Zendesk MCP tools"

Create a full domain:

"Create a Payments domain with a PaymentService, PaymentProcessed event, and ProcessPayment command"

Document from your codebase:

"Look at my src/ directory and generate EventCatalog documentation for the services and events you find"

Map a C4 model:

"Use this Structurizr DSL file to map our C4 model into my existing EventCatalog"

Add a business flow:

"Document the checkout flow from cart submission through payment processing to order confirmation"

Map an agent workflow:

"Map the fraud review flow where the FraudReviewAgent checks risk signals before payment capture"

Scaffold a new catalog:

"I don't have an EventCatalog yet, help me create one and document my architecture"

License

MIT

About

AI agent skills for EventCatalog documentation, SDK usage, and best practices

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors