📖 EventCatalog - MCP Server

📖 EventCatalog - MCP Server

site icon
2025.03.24 0
TypeScript架构文档事件驱动架构开发效率
EventCatalog MCP Server 是一个开源工具,旨在帮助用户从 EventCatalog 中获取关于事件驱动架构的深入见解。它允许用户通过 MCP 客户端(如 Claude、Cursor、Windsurf 等)直接查询架构信息,包括域、服务、消息、模式等。该服务器支持快速获取 OpenAPI 和 AsyncAPI 规范,以及事件、查询、命令和服务的模式。
View on GitHub

Overview

基本能力

产品定位

EventCatalog MCP Server 是一个连接 EventCatalog 和 MCP 客户端的桥梁,旨在通过 AI 增强对事件驱动架构的理解和查询能力。

核心功能

  • 连接任何 MCP 客户端(如 Claude、Cursor、Windsurf 等)
  • 在本地机器上运行 MCP 服务器
  • 连接 EventCatalog 实例
  • 查询架构信息(域、服务、消息等)
  • 查询 OpenAPI 和 AsyncAPI 规范
  • 获取事件、查询、命令和服务的模式

适用场景

  • 开发者集成 MCP 服务器到支持的 IDE(如 Cursor、Windsurf)
  • 利益相关者在使用的工具中查询架构信息(如 Claude)
  • 使用不支持 MCP 协议的工具时,通过 llms.txt 标准集成其他 LLM 工具(如 Gemini、GPT-4)

工具列表

  • get_domains: 获取目录中的所有域
  • get_services: 获取目录中的所有服务
  • get_events: 获取目录中的所有事件
  • get_commands: 获取目录中的所有命令
  • get_queries: 获取目录中的所有查询
  • get_flows: 获取目录中的所有流
  • get_teams: 获取目录中的所有团队
  • get_team: 获取目录中的特定团队
  • get_users: 获取目录中的所有用户
  • get_user: 获取目录中的特定用户
  • get_event_schema: 获取特定事件的模式
  • get_query_schema: 获取特定查询的模式
  • get_command_schema: 获取特定命令的模式
  • get_openapi_spec: 获取特定服务的 OpenAPI 规范
  • get_asyncapi_spec: 获取特定服务的 AsyncAPI 规范

常见问题解答

  • 如何添加 MCP 服务器到 Claude Desktop?
  • 如何添加 MCP 服务器到 Cursor?
  • 如何为项目配置 MCP 服务器?

使用教程

使用依赖

  1. 在 EventCatalog 实例中启用 LLMS.txt 功能
  2. 配置 eventcatalog.config.js 文件
  3. 部署启用了 LLMS.txt 功能的 EventCatalog 实例

安装教程

  1. 启用 LLMS.txt 功能
  2. 部署 EventCatalog 实例

调试方式

  • 使用 npx @eventcatalog/mcp-server {URL_TO_YOUR_EVENTCATALOG_INSTANCE} 运行 MCP 服务器
  • 在 Cursor 设置中添加 MCP 服务器
  • 在 Claude Desktop 配置文件中添加 MCP 服务器

API

资源

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

许可证

该项目遵循 EventCatalog Pro Edition 开源许可条款。