Skip to content

event-catalog/eventstorm-to-catalog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

EventStorm to EventCatalog - MCP Example

EventStorm to EventCatalog Converter

Experimental project that will covert your EventStorming output into a documented EventCatalog using the EventCatalog MCP server.

This is still experimental and a work in progress. You may find small issues when building your catalog.

What is this?

This project demonstrates how to automatically convert EventStorming output into structured EventCatalog documentation. EventStorming is a collaborative workshop technique for exploring complex business domains, and EventCatalog is a documentation tool for event-driven architectures with a focus on domain-driven design.

Prerequisites

Installation

Install the EventCatalog MCP server for Claude Code:

claude mcp add --transport stdio eventcatalog -- npx @eventcatalog/mcp-server@latest https://demo.eventcatalog.dev {EVENTCATALOG_SCALE_LICENSE_KEY}

You can get a free EventCatalog Scale license key from the EventCatalog website.

Usage

  1. Configure the EventCatalog MCP server in your session (using the command above).
  2. Take a photo of your Event Storming board or have an Event Storming image ready
  3. Open Claude Code and navigate to your project directory
  4. Reference your Event Storm image and prompt your LLM to convert the image to an EventCatalog:
Turn this photo of an Event Storming board into an EventCatalog.

Claude will analyze your Event Storming image and automatically generate:

  • Domain definitions
  • Service documentation
  • Event definitions
  • Command definitions
  • Flow documentation
  • Relationships between components

Example

This repository includes an example Event Storming session (storm.jpg) showing a claims processing workflow with:

  • Commands (blue): Submit claim, Check documentation, Check insurance, etc.
  • Events (orange): Claim submitted, Claim registered, Payment performed, etc.
  • Aggregates (yellow): Claim, Assessment, Payment
  • Actors (user icons): Customer, Administrator, Claims department personnel
  • Issues (pink): Policy management context questions

The generated EventCatalog documentation is available in the eventcatalog/ directory.

EventCatalog Structure

The generated EventCatalog follows this structure:

eventcatalog/
   domains/              # Domain definitions and subdomains
   services/            # Service documentation
   events/              # Event definitions
   commands/            # Command definitions
   flows/               # Business flow documentation
   eventcatalog.config.ts  # EventCatalog configuration

Running the Generated EventCatalog

To view your generated EventCatalog:

cd eventcatalog
npm install
npm run dev

Then open your browser to view the interactive documentation at http://localhost:3000.

Benefits

  • Fast Documentation: Convert hours of manual documentation into minutes
  • Consistency: Generated documentation follows EventCatalog standards
  • Collaboration: Bridge the gap between workshop sessions and technical documentation
  • Iteration: Quickly update documentation as your Event Storming evolves

Learn More

License

This is an example project demonstrating the EventCatalog MCP capabilities.

About

Turning EventStorming outputs into an EventCatalog using EventCatalog MCP

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors