Rationale for the EventCatalog MCP Server Component

EventCatalog serves as the definitive open-source registry for documenting complex event-driven systems. It centralizes metadata for your architectural spheres (domains), operational units (services), and data contracts (messages/events).

The EventCatalog MCP Server extends the utility of this registry by allowing developers to pose natural language questions against their architecture documentation directly from integrated development tools that support the Model Context Protocol (MCP).

Illustrative Query Examples:

• Enumerate all message types currently active across the entire system topology.
• Provide an in-depth analysis of the operational profile for the service designated as '{service}'.
• Identify relevant events within the architecture that pertain to customer onboarding workflows initiated by a 'user signup' action.
• Retrieve the formal data structure (schema) for the communication artifact named UserCreated as recorded in EventCatalog.
• Given a proposed modification to the UserCreated schema, analyze and list all dependent downstream consuming components that might experience impact.

Bypassing manual navigation through documentation portals, developers can elicit required architectural intelligence immediately via conversational prompts directed at the MCP server.

Key Features of the EventCatalog MCP Integration

• 🤖 Seamless connectivity with diverse MCP-enabled assistants (Claude, Cursor, Windsurf, etc.).
• 🤖 Simple local deployment initiation via a single command-line invocation.
• 🤖 Direct integration points to configured EventCatalog repositories.
• 🤖 Facilitates sophisticated interrogations concerning system architecture structure.
• 🤖 Capability to query specifications defined in OpenAPI and AsyncAPI formats.
• 🤖 Detailed inquiries about the delineation of domains, services, messages, and related artifacts.
• 🤖 On-demand retrieval of serialization formats (schemas) for events, remote procedure calls (queries/commands), and service interfaces (OpenAPI, AsyncAPI, JSON Schema).
• 🤖 Explanations and context resolution for terminology within the ubiquitous language pertaining to specific business domains.

Initial Setup Procedures

Deployment Prerequisites

Prerequisite one: Activation of the LLMS.txt feature within your active EventCatalog deployment is mandatory.

1. Modify your eventcatalog.config.js configuration file to enable the LLMS.txt feature.
2. Redeploy your EventCatalog instance reflecting the newly activated feature flag.

Subsequently, acquiring an EventCatalog Scale license key is necessary; a complimentary 14-day evaluation key is obtainable from EventCatalog Cloud.

Automated Installation via Smithery

To expedite the integration of EventCatalog for use with Claude Desktop automatically via the Smithery utility:

bash npx -y @smithery/cli install @event-catalog/mcp-server --client claude

Configuring Context-Aware Clients (MCP)

Integration methodology varies based on the chosen MCP client environment.

Guidance links for specific client onboarding:

• Configuring for Claude Desktop
• Configuring for Cursor

Integrating the MCP Server with Claude Desktop

For utilization within the Claude Desktop application, append the subsequent configuration block to your claud_desktop_config.json file. (Locate this file at ~/Library/Application Support/Claude/claud_desktop_config.json on macOS, or %APPDATA%\Claude\claud_desktop_config.json on Windows).

js { "mcpServers": { "eventcatalog": { "command": "npx", "args": [ "-y", "@eventcatalog/mcp-server", "https://demo.eventcatalog.dev", // Substitute with your definitive EventCatalog endpoint URL "ABCD-1234-5678-9012-3456-7890" // Substitute with your procured EventCatalog Scale authorization credential ] } } }

Integrating the MCP Server with Cursor

Navigate to Cursor Settings -> MCP Servers -> Select 'Add MCP Server'.

• Identifier (Name): eventcatalog
• Execution Program (Command): npx
• Parameters (Args): -y @eventcatalog/mcp-server {URL_TO_YOUR_EVENTCATALOG_INSTANCE}

Project-Specific Configuration

Cursor permits the definition of project-scoped server configurations using .mcp.json files placed within the relevant project directory structure.

{ "mcpServers": { "eventcatalog": { "command": "npx", "args": ["-y", "@eventcatalog/mcp-server", "https://demo.eventcatalog.dev", "ABCD-1234-5678-9012-3456-7890"] } } }

Refer to the Cursor documentation on Model Context Protocol configuration for exhaustive details on setting up project context overrides.

Supported Protocol Operations (API)

This section enumerates the functional interfaces exposed by the MCP server for client interaction.

Operational Toolset

• find_resources
• Discovers and lists all documented assets accessible within the EventCatalog repository.
• find_resource
• Retrieves granular metadata for a specified architectural component (service, domain, event, command, query, or flow), identified by its unique ID and version designation.
• find_producers_and_consumers
• Identifies upstream sources (producers/senders) and downstream destinations (consumers/receivers) associated with a particular service entity.
• get_schema
• Fetches and returns the formal data serialization definition for any registered event, command, query, or service interface.
• review_schema_changes
• Performs a comparative analysis of schema revisions, flagging potential backward-incompatible modifications and proposing remedial adjustments.
• explain_ubiquitous_language_terms
• Offers semantic explanations for terms derived from the ubiquitous language context relevant to a specified domain.
• find_owners
• Locates the designated custodians (teams or individuals) responsible for domains, services, messages, flows, or entities documented in EventCatalog.
• create_flow
• Generates a new business workflow visualization (recorded as a Markdown file) based on a descriptive text input. The tool intelligently cross-references existing architectural components to formulate the optimal flow representation, which is then renderable within EventCatalog.

Addressable Resource Locators

• eventcatalog://all
• Catalog sweep: Includes all recorded messages, operational domains, and system services.
• eventcatalog://events
• Collection of all defined asynchronous message payloads (events).
• eventcatalog://domains
• Index of all delineated business domains.
• eventcatalog://services
• Index of all deployed or defined software services.
• eventcatalog://queries
• Index of all defined request/response patterns (queries).
• eventcatalog://commands
• Index of all defined requests for state mutation (commands).
• eventcatalog://flows
• Index of all documented business process visualizations (flows).
• eventcatalog://teams
• Index of all registered responsible organizational teams.
• eventcatalog://users
• Index of all listed individual stewards.

Feature Expansion Requests

We are actively expanding the supported API surface. Should your operational needs require an unlisted function, kindly submit a request via opening an issue, and we will prioritize its integration into the server functionality.

Community Contribution Guidelines

We welcome external contributions to enhance this project.

1. Fork the source repository.
2. Execute pnpm install within the project root to resolve dependencies.
3. Execute pnpm run build to compile the distributable artifacts.

To utilize a locally compiled version as your MCP server source, adjust your client configuration to point to the dist output directory.

Example configuration adjustment for Cursor:

{ "mcpServers": { "eventcatalog": { "command": "npx", "args": ["-y", "tsx /PATH_TO_YOUR_REPO/src/index.ts", "https://demo.eventcatalog.dev", "ABCD-1234-5678-9012-3456-7890"] } } }

Project Underwriters

Gratitude extended to our valued project sponsors for their financial backing.

Gold Tier Contributors

Sponsorships ensure the continued viability and expansion of EventCatalog. Explore opportunities to contribute or visit our support page.

Enterprise Partnership and Support

We offer tailored enterprise collaboration options, encompassing dedicated technical assistance, accelerated feature implementation, bespoke integrations, and consultative services.

Details regarding our professional offerings are available on our services portal.

Licensing Information

Access to this specific feature set is included as part of the EventCatalog Pro Edition subscription tier.