Skip to main content

Getting Started

The EventCatalog MCP server runs locally on your machine.

This means you can use it with any LLM or AI application that supports the MCP protocol.

Configure EventCatalog

First you need to configure your EventCatalog instance to enable the LLMS.txt feature.

  1. Enable the LLMS.txt feature in your EventCatalog instance, by configuring your eventcatalog.config.js file.
  2. Deploy your EventCatalog instance with the LLMS.txt feature enabled.

Get an EventCatalog Scale License

To use the EventCatalog MCP server, you need to have a valid EventCatalog Scale license.

You can get a free 14 day trial license at EventCatalog Cloud.

Configure your MCP Client

  • Claude Desktop
    • Guide to use EventCatalog with Claude Desktop.
  • Cursor
    • Guide to use EventCatalog with Cursor.
  • Windsurf
    • Guide to use EventCatalog with Windsurf.

Using other MCP Clients

If you are using another MCP client, you can use the EventCatalog MCP server by adding it to your MCP client.

The command you need to use is:

npx -y @eventcatalog/mcp-server {URL_TO_YOUR_EVENTCATALOG_INSTANCE} {EVENTCATALOG_LICENSE_KEY}