mcp

EventCatalog (MCP Server) lets you query and interact with your EventCatalog instance directly from your MCP clients (like Claude, Cursor, Windsurf, etc.) using the Model Context Protocol. It supports a range of APIs to discover resources, fetch schemas, inspect owners and producers/consumers, and review schema changes. You can run the server in STDIO mode for local development or switch to HTTP mode to expose a container-friendly HTTP API for production deployments. Typical usage is to run the MCP server once and point your MCP client to it with the appropriate URL or transport method, then issue natural-language style prompts to retrieve domain, service, event, and schema information. The server exposes tools such as find_resources, find_resource, find_owners, find_producers_and_consumers, get_schema, review_schema_changes, explain_ubiquitous_language_terms, and create_flow to help you model and understand your architecture.

Prerequisites:

• Node.js and npm/yarn installed on your machine
• Access to the internet to fetch the MCP server package

Installation steps:

1. Ensure you have Node.js installed. Verify: node -v npm -v
2. Install or run the MCP server via npx (no permanent install required): npx -y @eventcatalog/mcp-server https://your-eventcatalog-url YOUR_LICENSE_KEY
3. If you prefer to pin the version or install locally, you can install the package globally or locally and run the server similarly: npm install -g @eventcatalog/mcp-server mcp-server https://your-eventcatalog-url YOUR_LICENSE_KEY
4. To run in HTTP mode (recommended for production), pass the http transport and port as per the server’s guidance (see Docker Deployment Guide in the repository): npx -y @eventcatalog/mcp-server https://your-eventcatalog-url YOUR_LICENSE_KEY http 3000
5. Optional: set environment variables for convenience: MCP_TRANSPORT=http MCP_HTTP_PORT=3000 LICENSE_KEY=YOUR_LICENSE_KEY

Tips and common issues:

• Ensure you replace https://your-eventcatalog-url and YOUR_LICENSE_KEY with your actual EventCatalog URL and Scale license key.
• If you enable HTTP mode, be mindful of network security and expose the port only to trusted clients.
• In STDIO mode, the server communicates via standard input/output and is ideal for desktop MCP clients like Claude Desktop and Cursor; no port exposure is needed.
• If you encounter authentication or license errors, double-check that the license key is valid for your environment and that the URL is reachable from the host running the MCP server.
• The server supports a rich set of APIs (find_resources, get_schema, etc.). Use these to programmatically explore your architecture and generate insights for documentation or onboarding.