<div align="center">

<h1>📖 EventCatalog - MCP 服务器</h1> <h3>直接从您的 MCP 客户端（<a href="https://www.anthropic.com/claude">Claude</a>、<a href="https://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/>

功能

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

使用 AI 从 EventCatalog 获取更多价值

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

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

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

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

开始使用

安装

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

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

设置 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" // 替换为您的 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。 如果您需要任何特定的东西，请打开一个 issue，我们会将其添加到服务器中。

TODO

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

• [ ] 添加对私有托管 EventCatalog 实例的支持
  • 我们向 EventCatalog 实例发出获取请求，让用户指定我们可以添加到每个请求的自定义标头或身份验证参数。
• [ ] 如果我们得到社区的兴趣，添加提示/工具来写入 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"]
    }
  }
}

赞助商

感谢我们的项目赞助商。

黄金赞助商

<div align="center"> <picture> <source srcset="./images/sponsors/gravitee-logo-white.webp" media="(prefers-color-scheme: dark)" /> <img alt="hookdeck" src="./images/sponsors/gravitee-logo-black.svg" width="50%" /> </picture> <p style="margin: 0; padding: 0;">管理、保护和管理您组织中的每个 API</p> <a href="https://gravitee.io?utm_source=eventcatalog&utm_medium=web&utm_campaign=sponsorship" target="_blank">了解更多</a> </div>

<hr />

<div align="center"> <img alt="oso" src="./images/sponsors/oso-logo-green.png" width="30%" /> <p style="margin: 0; padding: 0;">为您的企业提供 Apache Kafka 专业服务 </p> <a href="https://oso.sh/?utm_source=eventcatalog&utm_medium=web&utm_campaign=sponsorship" target="_blank" >了解更多</a> </div>

<hr />

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

企业支持

有兴趣与我们合作吗？ 我们的产品包括专门的支持、优先协助、功能开发、自定义集成等等。

在我们的服务页面上查找更多详细信息。

许可证

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