TalkEventsToMe

by chiefnamingofficer

289 downloads
Not rated
GitHub

About

A learning project for MCP server integration, between eventcatalog.io and cursor.

Details

Author
chiefnamingofficer
Downloads
289
Categories
Other

- Integrates with EventCatalog via MCP protocol
- Provides tools like find_resources, find_resource, find_producers_and_consumers, get_schema, review_schema_changes, and explain_ubiquitous_language_terms
- Exposes resources for all messages, events, domains, services, queries, commands, flows, teams, and users
- Works with Claude, Cursor, Windsurf, and other MCP-compatible clients
- Designed for learning and exploration of event-driven architecture

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name TalkEventsToMe
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Configure the MCP server using the provided .mcp.json file (requires an EventCatalog Scale license key), install dependencies automatically via npx, and restart the MCP-compatible client (e.g., Cursor) to load the server. Verify by asking questions about your event catalog.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "talkeventstome": {
            "TalkEventsToMe": {
                "command": "npx",
                "args": [
                    "-y",
                    "@eventcatalog/mcp-server",
                    "--help"
                ]
            }
        }
    }
}

McpServers

{
    "TalkEventsToMe": {
        "command": "npx",
        "args": [
            "-y",
            "@eventcatalog/mcp-server",
            "--help"
        ]
    }
}

TalkEventsToMe

A learning project focused on integrating with EventCatalog via MCP (Model Context Protocol) server to explore event-driven architecture questions and insights.

🎯 Project Purpose

This project demonstrates how to leverage the EventCatalog MCP Server to interact with our organization's EventCatalog instance and get insights about our event-driven architecture directly from AI assistants like Claude, Cursor, and Windsurf.

πŸ—οΈ Architecture Overview

- EventCatalog Instance: https://eventcatalog.compassdigital.org/ (Google OAuth protected)
- MCP Server: @eventcatalog/mcp-server
- Client: Cursor IDE with MCP integration
- Authentication: Requires EventCatalog Scale license key

πŸš€ Setup Instructions

Prerequisites

1. EventCatalog Scale License: You'll need a license key for EventCatalog Scale
- Get a 14-day trial from EventCatalog Cloud
- Replace YOUR_EVENTCATALOG_SCALE_LICENSE_KEY in .mcp.json

2. Access to EventCatalog Instance: Ensure you have access to https://eventcatalog.compassdigital.org/

Installation

1. Configure MCP Server: The .mcp.json file is already configured for this project
2. Install Dependencies: The MCP server will be installed automatically via npx
3. Restart Cursor: After updating .mcp.json, restart Cursor to load the MCP server

Verification

Once configured, you should see the EventCatalog MCP server available in Cursor. You can verify by asking questions about your event catalog.

πŸ€– Available MCP Tools

The EventCatalog MCP server provides the following tools:

Tools

- find_resources - Find resources available in EventCatalog - find_resource - Get detailed information about services, domains, events, commands, queries, or flows - find_producers_and_consumers - Get producers and consumers for a service - get_schema - Returns schema for services, events, commands, or queries - review_schema_changes - Reviews schema changes for breaking changes - explain_ubiquitous_language_terms - Explain domain-specific terminology

Resources

- eventcatalog://all - All messages, domains and services - eventcatalog://events - All events - eventcatalog://domains - All domains - eventcatalog://services - All services - eventcatalog://queries - All queries - eventcatalog://commands - All commands - eventcatalog://flows - All flows - eventcatalog://teams - All teams - eventcatalog://users - All users

πŸ” Learning Questions

Here are the key questions this project aims to explore:

Menu Publishing Events

1. Is there an event when a new menu gets published? 2. Which team owns that event? 3. How can I subscribe to that event? 4. What do I need to know in order to process that event? 5. What other menu service related events exist?

Event Registration & Discovery

6. I have my own service, how can I register a new event with the eventcatalog? 7. Do I need to notify someone when I register the new event and how would they be able to subscribe to my event?

Architecture Insights

8. Is there any information on our event driven architecture? 9. Is there an event flow you could create that shows when a menu is being published and who are all the subscribers of that event?

Error Handling & Reliability

10. What if an event fails to be delivered, how would a subscriber get to know about that situation?

πŸŽ“ Learning Objectives

Through this project, you'll learn:

- How to configure MCP servers for EventCatalog integration
- How to query event-driven architecture documentation programmatically
- How to discover events, schemas, and relationships in your architecture
- How to understand team ownership and responsibilities
- How to identify event flows and dependencies
- How to explore error handling and reliability patterns

πŸ“š Resources

- EventCatalog MCP Server GitHub
- EventCatalog MCP Documentation
- Our EventCatalog Instance
- MCP Protocol Documentation

πŸ”§ Troubleshooting

Common Issues

1. License Key Issues: Ensure your EventCatalog Scale license key is valid and not expired
2. Network Access: Verify you can access the EventCatalog instance from your network
3. OAuth Issues: Make sure you're authenticated with Google OAuth for the EventCatalog instance
4. MCP Server Not Loading: Restart Cursor after modifying .mcp.json

Debug Commands

```bash

No reviews yet β€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.