📖 EventCatalog - MCP Server

📖 EventCatalog - MCP Server

site icon
2025.04.16 13
TypeScript架构分析开发工具开发效率
EventCatalog - MCP Server 是一个开源工具,旨在帮助用户从EventCatalog中获取关于事件驱动架构的深入见解。它允许用户通过MCP客户端(如Claude、Cursor、Windsurf等)直接查询架构信息,包括域、服务、消息、模式等。该服务器支持本地运行,并能与EventCatalog实例连接,提供快速的问题解答和架构分析。
View on GitHub

Overview

基本能力

产品定位

EventCatalog - MCP Server 是一个专为开发者设计的工具,用于从EventCatalog中提取和查询架构信息,提升开发效率和架构理解。

核心功能

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

适用场景

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

工具列表

  • 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文件以启用LLMS.txt功能。
  3. 部署启用了LLMS.txt功能的EventCatalog实例。

安装教程

  1. 确保已安装Node.js和npm。
  2. 运行以下命令安装MCP服务器:
npx -y @eventcatalog/mcp-server

调试方式

  1. 克隆仓库:
git clone https://github.com/eventcatalog/mcp-server.git
  1. 安装依赖:
pnpm install
  1. 构建项目:
pnpm run build
  1. 使用构建的MCP服务器:
{
  "mcpServers": {
    "eventcatalog": {
      "command": "npx",
      "args": ["-y", "tsx /PATH_TO_YOUR_REPO/src/index.ts", "https://demo.eventcatalog.dev"]
    }
  }
}

许可证

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