阅读文档 | 查看演示

功能

• 🤖 连接到任何 MCP 客户端（如 Claude, Cursor, Windsurf 等）
• 🤖 通过一条命令在本地运行 MCP 服务器
• 🤖 连接到您的 EventCatalog 实例
• 🤖 询问关于您架构的问题
• 🤖 询问关于您的 OpenAPI 和 AsyncAPI 规范的问题
• 🤖 询问关于领域、服务和消息等更多信息
• 🤖 获取事件、查询、命令和服务的模式（OpenAPI, AsyncAPI, JSON 模式）

使用 AI 从 EventCatalog 中获得更多价值

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

EventCatalog 将为您可视化架构，提供为利益相关者添加语义意义的能力，托管您的 OpenAPI 和 AsyncAPI 规范，并与世界上任何代理集成。

使用 EventCatalog MCP 服务器，您可以通过在已经使用的工具中询问有关架构的问题来从 EventCatalog 中获得更多价值。

• 开发人员可以将 MCP 服务器与支持 MCP 的 IDE 集成（例如 Cursor, Windsurf）
• 利益相关者可以在他们使用的工具中询问有关架构的问题（例如 Claude）
• 如果您使用的工具不支持 MCP 协议，您仍然可以使用 llms.txt 标准与其他 LLM 工具集成（例如 Gemini, GPT-4）

快速开始

安装

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

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

设置 MCP 客户端

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

你可以从下面找到一些有用的链接来开始使用。

• Claude Desktop
• Cursor

将 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" // Replace with your EventCatalog URL
      ]
    }
  }
}

将 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"]
    }
  }
}

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

API

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

资源

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

工具

• get_domains
  • 获取并返回目录中所有域的列表
• get_services
  • 获取并返回目录中所有服务的列表
• get_events
  • 获取并返回目录中所有事件的列表
• get_commands
  • 获取并返回目录中所有命令的列表
• get_queries
  • 获取并返回目录中所有查询的列表
• get_flows
  • 获取并返回目录中所有流程的列表
• get_teams
  • 获取并返回目录中所有团队的列表
• get_team
  • 从目录中获取并返回指定的团队
• get_users
  • 获取并返回目录中所有用户的列表
• get_user
  • 从目录中获取并返回指定的用户

模式

• get_event_schema
  • 根据给定的事件ID获取并返回模式
• get_query_schema
  • 根据给定的查询ID获取并返回模式
• get_command_schema
  • 根据给定的命令ID获取并返回模式

OpenAPI

• get_openapi_spec
  • 根据给定的服务ID获取并返回OpenAPI规范
• get_asyncapi_spec
  • 根据给定的服务ID获取并返回AsyncAPI规范

缺少某个API？

我们正在努力向MCP服务器添加更多API。如果你需要特定的功能，请提交一个问题，我们会将其添加到服务器上。

待办事项

对于MCP服务器的一些想法，欢迎随时添加到列表中！

• 添加对私有托管 EventCatalog 实例的支持
  • 我们向 EventCatalog 实例发出 fetch 请求，让用户可以指定自定义头或认证参数，我们可以将这些参数添加到每个请求中。
• 如果社区有兴趣，添加提示/工具以写入 EventCatalog
• 添加获取团队和用户的支持
• 添加从 EventCatalog 获取流的支持

贡献

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"]
    }
  }
}

赞助商

感谢我们的项目赞助商。

金牌赞助商

赞助商帮助使 EventCatalog 可持续发展，想要帮助这个项目吗？联系我们！或者访问我们的赞助页面。

企业支持

有兴趣与我们合作吗？我们提供的服务包括专属支持、优先协助、功能开发、定制集成等更多。

在我们的服务页面上找到更多详情。

许可证

此功能的使用是 EventCatalog Pro 版本的一部分。