返回市场
MCP服务器

MCP服务器

作者:event-catalog17 星标更新:2025-10-31

项目介绍

<div align="center"> <h1>📖 EventCatalog - MCP 服务器</h1> <h3>通过从您的 MCP 客户端(如 <a href="https://www.anthropic.com/claude">Claude</a>, <a href="https://www.cursor.com/">Cursor</a>, <a href="https://codeium.com/windsurf">Windsurf</a> 等)直接获取 EventCatalog 的洞察来节省时间和金钱。</h3> <!-- <img width="745" alt="Screenshot 2024-12-13 at 09 56 05" src="https://github.com/user-attachments/assets/f537ec1f-54ee-4de1-996c-c6b72191be39" /> --> <img width="745" alt="EventCatalog" src="./images/mcp.png" /> <h4>特性:询问领域、服务和消息。几秒钟内获得答案。请求模式、谁拥有什么以及更多。</h4>

阅读文档 | 查看演示

</div> <hr/>

为什么选择 EventCatalog MCP 服务器?

EventCatalog 是一个开源工具,帮助您记录事件驱动架构。 使用 EventCatalog,您可以记录您的领域、服务和消息、模式等。

使用 EventCatalog MCP 服务器,您可以通过在已使用的工具中提问来获得更多关于架构的信息。

示例问题:

  • 我们的架构中有哪些事件?
  • 告诉我更多关于 {service} 服务的信息。
  • 我想创建一个新功能,在用户注册时发送电子邮件,我们的架构中有哪些与用户注册相关的事件?
  • 获取 EventCatalog 中 UserCreated 事件的模式。
  • 这是 UserCreated 模式的新版本,这个变化会影响哪些下游消费者?

与其深入架构寻找答案,您可以直接向 MCP 服务器提问。


EventCatalog MCP 特性

  • 🤖 连接到任何 MCP 客户端(如 Claude, Cursor, Windsurf 等)
  • 🤖 通过一条命令在本地机器上运行 MCP 服务器
  • 🤖 连接到您的 EventCatalog 实例
  • 🤖 提问关于您的架构
  • 🤖 提问关于您的 OpenAPI 和 AsyncAPI 规范
  • 🤖 提问关于领域、服务和消息,以及其他更多内容
  • 🤖 获取事件、查询、命令和服务的模式(OpenAPI、AsyncAPI、JSON Schema)
  • 🤖 提问关于任何领域的通用语言及其实体

快速开始

安装

首先,您需要在 EventCatalog 实例中启用 LLMS.txt 功能

  1. 在您的 EventCatalog 实例中启用 LLMS.txt 功能,通过配置您的 eventcatalog.config.js 文件。
  2. 部署您的 EventCatalog 实例,启用 LLMS.txt 功能。

接下来,您需要获取 EventCatalog Scale 许可密钥,可以从 EventCatalog Cloud 获取 14 天试用许可密钥。

通过 Smithery 安装

要通过 Smithery 自动安装 EventCatalog for Claude Desktop:

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

设置 MCP 客户端

每个 MCP 客户端添加 MCP 服务器的方式不同。

以下是一些有用的链接,帮助您开始设置。

添加 MCP 服务器到 Claude Desktop

要在 Claude Desktop 中使用此功能,请在您的 claud_desktop_config.json 文件中添加以下内容。MacOS 上的完整路径为 ~/Library/Application Support/Claude/claud_desktop_config.json,Windows 上为 %APPDATA%\Claude\claud_desktop_config.json

{
  "mcpServers": {
    "eventcatalog": {
      "command": "npx",
      "args": [
        "-y",
        "@eventcatalog/mcp-server",
        "https://demo.eventcatalog.dev", // 替换为您自己的 EventCatalog URL
        "ABCD-1234-5678-9012-3456-7890" // 替换为您自己的 EventCatalog Scale 许可密钥
      ]
    }
  }
}

添加 MCP 服务器到 Cursor

进入 Cursor 设置 -> MCP 服务器 -> 添加 MCP 服务器。

  • 名称:eventcatalog
  • 命令:npx
  • 参数:-y @eventcatalog/mcp-server {URL_TO_YOUR_EVENTCATALOG_INSTANCE}

项目配置

您还可以在项目中创建 .mcp.json 文件,使用 Cursor 配置项目的 MCP 服务器。

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

有关项目配置的更多信息,请参阅 Cursor 文档

API

以下是 MCP 服务器支持的所有 API 列表。

工具

  • find_resources
    • 查找 EventCatalog 中可用的资源
  • find_resource
    • 使用其 ID 和版本获取 EventCatalog 中服务、领域、事件、命令、查询或流程的更多信息
  • find_producers_and_consumers
    • 获取 EventCatalog 中服务的生产者(发送)和消费者(接收)
  • get_schema
    • 返回 EventCatalog 中服务(例如 OpenAPI、AsyncAPI、GraphQL)、事件、命令或查询的模式
  • get_schemas
    • 返回 EventCatalog 中服务(例如 OpenAPI、AsyncAPI、GraphQL)、事件、命令或查询的模式列表
  • review_schema_changes
    • 审查模式更改以查找破坏性更改并建议修复。
  • explain_ubiquitous_language_terms
    • 解释给定领域的通用语言术语
  • find_owners
    • 查找 EventCatalog 中领域、服务、消息、事件、命令、查询、流程或实体的所有者(团队或用户)
  • create_flow
    • 根据业务工作流描述创建 EventCatalog 中的新流程。
    • 该工具会检查 EventCatalog 中的所有资源,以找到最匹配描述的资源。
    • 流程将被创建(markdown 文件),并在 EventCatalog 中可视化。

资源

  • eventcatalog://all
    • EventCatalog 中的所有消息、领域和服务
  • eventcatalog://events
    • EventCatalog 中的所有事件
  • eventcatalog://domains
    • EventCatalog 中的所有领域
  • eventcatalog://services
    • EventCatalog 中的所有服务
  • eventcatalog://queries
    • EventCatalog 中的所有查询
  • eventcatalog://commands
    • EventCatalog 中的所有命令
  • eventcatalog://flows
    • EventCatalog 中的所有流程
  • eventcatalog://teams
    • EventCatalog 中的所有团队
  • eventcatalog://users
    • EventCatalog 中的所有用户

缺少 API?

我们正在努力增加更多的 API 到 MCP 服务器。如果您需要特定的功能,请 打开一个问题,我们将将其添加到服务器。

贡献

  1. 克隆仓库
  2. 运行 pnpm install 安装依赖项
  3. 运行 pnpm run build

要使用构建作为您的 MCP 服务器,可以将您的 MCP 客户端指向 dist 文件夹。

示例用于 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"]
    }
  }
}

许可

使用此功能是 EventCatalog Scale 计划的一部分。