event-catalogue

Generate a versioned event catalogue from IEventData implementations.

4|1|Updated Mar 15, 2026
One-click install
npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill event-catalogue
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: event-catalogue
Source: https://github.com/FaysilAlshareef/dotnet-ai-kit/tree/main/skills/microservice/event-catalogue
Command: npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill event-catalogue

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Cross-service event schemas are often scattered, inconsistent, and hard to discover. This Skill provides a centralized, versioned catalogue to document and govern event contracts across services.

Core Features & Use Cases

  • Generate a per-service or centralized event catalogue to enable discovery and governance for CQRS/event-driven architectures.
  • Enforce consistent naming and versioning of events, and enable cross-service contract validation.
  • Use with build-time tooling to validate that event data types are documented and kept in sync with code.

Quick Start

Run the event catalogue generator against your service assemblies to produce the events registry.

Frequently Asked Questions about event-catalogue

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document cross-service event schemas for discoverability?

To document cross-service event schemas, you need a centralized, versioned event catalogue that governs contracts. This Skill generates a structured registry by reflecting over your event data implementations, enabling discovery and governance for event-driven architectures.

How can I prevent drift between event contracts and code in CQRS architectures?

To prevent drift between event contracts and code, use build-time validation against your event catalogue. This Skill enforces sealed records and validates generated catalogue structures against your service assemblies to ensure documentation stays synchronized with code.

What is the best way to maintain a centralized event registry for multiple services?

The best way to maintain a centralized event registry is to automate generation at build time. This Skill outputs a structured event catalogue by reflecting over IEventData implementations, enforcing consistent naming and versioning across producing and consuming services.

Do I need sealed records to generate an event catalogue?

Yes, sealed records are required to generate an event catalogue using this Skill. The build-time generator enforces sealed records for your IEventData implementations to ensure strict immutability and reliable schema extraction for cross-service validation.

Can I validate event versioning across different services automatically?

Yes, you can validate event versioning across different services automatically. This Skill enforces consistent naming and versioning of events within the generated catalogue, enabling cross-service contract validation to prevent incompatible schema deployments.

When do I need a versioned event catalogue for cross-service communication?

You need a versioned event catalogue when multiple services produce and consume events and teams require a discoverable contract. It solves the problem of scattered, inconsistent event schemas by providing centralized governance for cross-service communication.