# @eventcatalog/mcp-server 中文文档 规范地址：https://npmcn.com/package/%40eventcatalog/mcp-server/ 版本：2\.1\.0 npm 元数据更新时间：2025-12-09T13:47:56.373Z 中文译文更新时间：2026-11-14T01:10:55.255Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40eventcatalog/mcp-server 原文对照：https://npmcn.com/package/%40eventcatalog/mcp-server/?lang=original 项目主页：https://github.com/event-catalog/mcp-server#readme 源码仓库：https://github.com/event-catalog/mcp-server ## 关键信息（来自 npm 元数据） - 包体积（解压后）：139 kB，51 个文件 - 模块格式：ES Module - TypeScript 类型：包内自带 - 运行依赖：5 个 - 首次发布：2025-03-17T14:50:23.962Z - 最新版本发布：2025-12-09T13:47:55.984Z - 近 30 天下载量：3618（2026-10-14 至 2026-11-12，npm 官方下载统计） - 已发布版本数：12（近 12 个月 3 个） ## 中文简介 EventCatalog 的 MCP 服务器 ## 安装 ```sh npm install @eventcatalog/mcp-server ``` 也可以使用：`pnpm add @eventcatalog/mcp-server`、`yarn add @eventcatalog/mcp-server`、`bun add @eventcatalog/mcp-server` ## README # QQ 事件Catalog - MCP 服务器 ### 通过直接从您的 MCP 客户端获取您的 EventCatalog 的真知灼见来节省时间和金钱( S)[克劳德](https://www.anthropic.com/claude), (中文(简体) ), [光标](https://www.cursor.com/), (中文(简体) ), [风起浪起](https://codeium.com/windsurf)页:1 ![EventCatalog](https://npmcn.com/package/%40eventcatalog/mcp-server/images/mcp.png) #### 特性:询问域、服务和消息。 几秒钟后得到答案。 要求计划,谁拥有更多的东西. [阅读文档](https://www.eventcatalog.dev/docs/development/getting-started/introduction) | [查看演示](https://demo.eventcatalog.dev/) * * * ## 为什么是事件Catalog MCP服务器? EventCatalog是一个开源工具,帮助您记录由事件驱动的架构. 使用 EventCatalog 可以记录您的域、 服务和信件、 计划以及更多 . 使用 **事件Catalog MCP 服务器** 您可以通过在您已经使用的工具中询问您的架构, 从您的 EventCatalog 中获取更多值 . 示例问题: - 我们建筑中有什么事件? - 告诉我更多关于{服务}服务. - 我想创建一个新功能, 当用户签名时会发送电子邮件, 我们的架构中有哪些事件与用户签名有关? - 把赛事计划给我 `UserCreated` 在事件Catalog. - 这是新版的 `UserCreated` 计划,下游的消费者会受到这个变化的影响吗? 而不是从您的架构中挖掘找到您需要的答案, 您可以直接从您的 MCP 客户端中询问 MCP 服务器 . * * * ## 事件Catalog MCP 特征 - QQ 连接到任何 MCP 客户端( S)[克劳德](https://www.anthropic.com/claude), (中文(简体) ), [光标](https://www.cursor.com/), (中文(简体) ), [风起浪起](https://codeium.com/windsurf)页:1 - QQ 用一个命令在您的机器上本地运行 MCP 服务器 - QQ 连接到您的事件Catalog 实例 - QQ 问你的建筑问题 - QQ 询问您的 OpenAPI 和 AsyncAPI 规格 - \* 询问域、服务和信息,以及更多 - 获取事件、查询、命令和服务计划(OpenAPI、AsyncAPI、JSON Schema) - QQ 为任何域及其实体询问无所不在的语言问题 * * * # 开始 ## 安装 首先,你需要启用 [`LLMS.txt` 特性](https://www.eventcatalog.dev/docs/development/developer-tools/llms.txt) 以事件Catalog为例. 1. 启用 [`LLMS.txt` 特性](https://www.eventcatalog.dev/docs/development/developer-tools/llms.txt) 在事件Catalog中,通过配置您 `eventcatalog.config.js` 文档. 2. 将您的事件Catalog 实例与 `LLMS.txt` 特性已启用. 接下来,您需要获得一个 EventCatalog 缩放许可证密钥, 您可以从 : [事件目录云](https://eventcatalog.cloud/)。 。 。 . ### 通过 Smithery 安装 自动通过 Claude 桌面安装事件Catalog [史密斯术](https://smithery.ai/server/@event-catalog/mcp-server)数字 : ```bash npx -y @smithery/cli install @event-catalog/mcp-server --client claude ``` ### 作为 Docker 容器运行 如果您想要将 MCP 服务器运行为一个独立的 Docker 容器( 例如, 运行为 HTTP 服务器), 请查看 [Docker 部署指南](https://npmcn.com/package/%40eventcatalog/mcp-server/README.Docker.md)。 。 。 . 这对于: - 在生产环境中运行 MCP 服务器 - 作为一种集装箱服务部署 - 在 HTTP 模式下运行与多个客户端的集成 - Kubernetes、Docker Swarm或其他容器管弦乐平台 ## 运输模式 事件Catalog MCP 服务器支持两种传输模式: ### STIO 模式( 默认) - 通信使用标准输入/输出 - Claude桌面和光标等本地开发和 MCP 客户端的理想 - 当您将服务器添加到您的 MCP 客户端时自动启动 - 不需要港口接触 - **建议赔偿额**: Claude Desktop, Cursor, Windsurf, 以及其他桌面 MCP 客户端 ### HTTP 模式 - 在指定的端口以 HTTP 服务器运行( 默认: 3,000) - 生产部署的理想和集装箱环境 - 允许多个客户端连接到单个服务器实例 - 包括用于监测的健康检查终点 - **建议赔偿额**: Docker部署、Kubernetes、生产环境和多客户设置 要使用 HTTP 模式, 请通过 `http` 作为传输参数 : ```bash npx -y @eventcatalog/mcp-server {URL} {LICENSE_KEY} http {PORT} ``` 或者设置 `MCP_TRANSPORT` 环境变量改为 `http` (见 [Docker 部署指南](https://npmcn.com/package/%40eventcatalog/mcp-server/README.Docker.md) 详细情况请查阅. ## 设置 MCP 客户端 每个MCP客户端都有不同的添加MCP服务器的方法. 您可以在下面找到一些有用的链接来启动 . - [克劳德桌面](https://npmcn.com/package/%40eventcatalog/mcp-server/#readme-adding-the-mcp-server-to-claude-desktop) - [光标](https://npmcn.com/package/%40eventcatalog/mcp-server/#readme-adding-the-mcp-server-to-cursor) ## 将 MCP 服务器添加到 Claude 桌面 要使用 Claude 桌面, 请在您的桌面上添加以下 `claud_desktop_config.json` 文档。 MacOS上的完整路径 : `~/Library/Application Support/Claude/claud_desktop_config.json`,在窗口上: `%APPDATA%\Claude\claud_desktop_config.json` ```js { "mcpServers": { "eventcatalog": { "command": "npx", "args": [ "-y", "@eventcatalog/mcp-server", "https://demo.eventcatalog.dev", // Replace with your EventCatalog URL "ABCD-1234-5678-9012-3456-7890" // Replace with your EventCatalog Scale license key ] } } } ``` ## 将 MCP 服务器添加到光标 转到光标设置 - > MCP 服务器 - > 添加 MCP 服务器 . - 名称 : `eventcatalog` - 命令 : `npx` - 参数 : `-y @eventcatalog/mcp-server {URL_TO_YOUR_EVENTCATALOG_INSTANCE}` ### 您工程的配置 您也可以创建 `.mcp.json` 在项目中使用光标配置您项目的 MCP 服务器的文件. ```json { "mcpServers": { "eventcatalog": { "command": "npx", "args": ["-y", "@eventcatalog/mcp-server", "https://demo.eventcatalog.dev", "ABCD-1234-5678-9012-3456-7890"] } } } ``` 您可以读取更多关于您的工程配置的 [光标文档](https://docs.cursor.com/context/model-context-protocol#configuration-locations)。 。 。 . # API 密码 以下是MCP服务器所支持的所有API列表. ## 工具 - `find_resources` - 查找 EventCatalog 中可用的资源, 包括服务、 域、 事件、 命令、 查询、 流量、 实体、 频道、 团队、 用户和 Docs - 支持按类型和搜索条件过滤 - 包括带有光标的页码支持 - `find_resource` - 在 EventCatalog 中获取更多关于服务、域、事件、命令、查询、流量、实体或频道的信息 - 返回完整的资源细节,包括规格、所有人、生产者和消费者 - `find_owners` - 在 EventCatalog 为域、服务、消息、事件、命令、查询、流量或实体查找所有者(团队或用户) - 返回带有文件链接的详细所有者信息 - `find_producers_and_consumers` - 在 EventCatalog 中获取服务的生产者(发送)和消费者(接收) - 帮助理解消息流和服务依赖性 - `get_schema` - 返回服务( 如 OpenAPI 、 AsyncAPI 、 GraphQL ) 、 事件、 命令或查询的系统 - 支持所有主要计划格式 - `review_schema_changes` - 审查打破更改的图案并提议修正 - 比较新旧办法以确定潜在的问题 - 为处理断续续的更改提供建议 - `explain_ubiquitous_language_terms` - 解释特定域的无所不在的语言术语 - 特定域名的定义和上下文 - `create_flow` - 在 EventCatalog 中创建新流程, 以描述业务工作流程 - 该工具将检查您在 EventCatalog 中的所有资源, 以找到匹配描述的最佳资源 - 流量将创建( markdown 文件) , 并且可以在 EventCatalog 中可视化 - `eventstorm_to_eventcatalog` - 将事件存储会话的照片转换成事件Catalog - 自动生成域、服务、事件、命令、流量和无所不在的语言术语 - 创建适当的文件夹结构和带有前题的 MDX 文件 - `create_eventcatalog` - 从零创建新事件Catalog工程 - 生成所有必要的配置文件( package.json, eventcatalog. config.ts) - 设置完整的文件夹结构和初始文档 ## 资源 资源可以快速访问您 EventCatalog 的数据收集。 可以用来了解你的建筑背景. - `eventcatalog://all` - 事件Catalog中的所有资源(消息、域名、服务、流量、团队、用户等) - 使用此选项来完整概述您的架构 - `eventcatalog://events` - 事件Catalog中的所有事件 - 包括事件名称、版本和描述 - `eventcatalog://commands` - 事件Catalog中的所有命令 - 查看系统中的所有命令消息 - `eventcatalog://queries` - 事件Catalog中的所有查询 - 访问所有查询信件 - `eventcatalog://services` - 事件Catalog中的所有服务 - 完整的服务清单及其元数据 - `eventcatalog://domains` - 事件Catalog中的所有域 - 查看域边界和子域 - `eventcatalog://flows` - 事件Catalog中的所有流量( 业务流程) - 访问工作流程定义和状态机器 - `eventcatalog://teams` - 事件Catalog中的所有团队 - 查看团队信息和所有权 - `eventcatalog://users` - 事件Catalog中的所有用户 - 用户简介和所有权信息 ## 缺少API? 我们正在努力在MCP服务器上添加更多的API. 如果你需要具体的东西,请 [打开一个问题](https://github.com/eventcatalog/mcp-server/issues) 我们会把它添加到服务器上. ## 捐款 1. 清除仓库 2. 运行 `npm install` 以安装依赖关系 3. 运行 `npm run build` ### 运行测试 ```bash npm test ``` 进行覆盖测试: ```bash npm test:coverage ``` 要将构建作为您的 MCP 服务器, 您可以将您的 MCP 客户端指向 `dist` 文件夹. 光标示例: ```json { "mcpServers": { "eventcatalog": { "command": "npx", "args": ["-y", "tsx /PATH_TO_YOUR_REPO/src/index.ts", "https://demo.eventcatalog.dev", "ABCD-1234-5678-9012-3456-7890"] } } } ``` # 许可证 此特性的使用是 [事件目录缩放计划](https://www.eventcatalog.dev/pricing) ## 常见问题 ### @eventcatalog/mcp-server 是什么？ EventCatalog 的 MCP 服务器 ### 如何安装 @eventcatalog/mcp-server？ 在项目目录运行 npm install @eventcatalog/mcp-server，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 eventcatalog-mcp-server，可以用 npx eventcatalog-mcp-server 直接运行。 ### @eventcatalog/mcp-server 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @eventcatalog/mcp-server 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @eventcatalog/mcp-server 可以商用吗？ @eventcatalog/mcp-server 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @eventcatalog/mcp-server 的下载量有多少？ 根据 npm 官方下载统计，@eventcatalog/mcp-server 在 2026/10/14 – 2026/11/12 这 30 天内被下载 3,618 次，日均约 121 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @eventcatalog/mcp-server 还在维护吗？ 最新版本 2\.1\.0 发布于 2025/12/09（11 个月前）；至今共发布 12 个版本，其中过去 12 个月发布了 3 个；首次发布于 2025/03/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。