特征
🤖 使用一个命令在你的机器上本地运行 MCP 服务器
🤖 连接到您的 EventCatalog 实例
🤖 询问有关您的架构的问题
🤖 询问有关您的 OpenAPI 和 AsyncAPI 规范的问题
🤖 询问域名、服务和消息等更多信息
🤖 获取事件、查询、命令和服务的模式(OpenAPI、AsyncAPI、JSON Schema)
Related MCP server: Mattermost MCP Server
使用 AI 从 EventCatalog 中获取更多价值
EventCatalog是一款开源工具,可帮助您记录事件驱动架构。使用 EventCatalog,您可以记录域、服务、消息、架构等等。
EventCatalog 将为您所有人可视化您的架构,提供为利益相关者添加语义的能力,托管您的 OpenPAI 和 AsyncAPI 规范并与世界上任何经纪人集成。
使用**EventCatalog MCP 服务器,**您可以通过在已经使用的工具中询问有关架构的问题,从 EventCatalog 中获得更多价值。
利益相关者可以使用他们使用的工具询问有关您的架构的问题(例如Claude )
如果您使用的工具不支持 MCP 协议,您仍然可以使用
llms.txt标准与其他 LLLM 工具集成(例如Gemini 、 GPT-4 )
入门
安装
首先,您需要在 EventCatalog 实例中启用LLMS.txt。
通过配置
eventcatalog.config.js文件,在 EventCatalog 实例中启用LLMS.txt。部署启用
LLMS.txt功能后的 EventCatalog 实例。
通过 Smithery 安装
要通过Smithery自动为 Claude Desktop 安装 EventCatalog:
设置 MCP 客户端
每个 MCP 客户端都有不同的添加 MCP 服务器的方式。
您可以在下面找到一些有用的链接来开始使用。
将 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
将 MCP 服务器添加到 Cursor
转到光标设置 -> MCP 服务器 -> 添加 MCP 服务器。
名称:
eventcatalog命令:
npx参数:
-y @eventcatalog/mcp-server {URL_TO_YOUR_EVENTCATALOG_INSTANCE}
您的项目的配置
您还可以在项目中创建.mcp.json文件,以使用 Cursor 为您的项目配置 MCP 服务器。
您可以在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 的架构
开放API
get_openapi_spec获取并返回给定服务 ID 的 OpenAPI 规范
get_asyncapi_spec获取并返回给定服务 ID 的 AsyncAPI 规范
缺少 API?
我们正在努力为 MCP 服务器添加更多 API。如果您需要特定功能,请提交问题,我们会将其添加到服务器。
待办事项
有关 MCP 服务器的一些想法,请随意添加到列表中!
[ ] 添加对私有托管 EventCatalog 实例的支持
我们向 EventCatalog 实例发出获取请求,让用户指定我们可以添加到每个请求的自定义标头或身份验证参数。
[ ] 如果社区感兴趣,请添加提示/工具来写入 EventCatalog
[ ] 添加获取团队和用户的支持
[ ] 添加从 EventCatalog 获取流的支持
贡献
克隆存储库
运行
pnpm install来安装依赖项运行
pnpm run build
要将构建用作您的 MCP 服务器,您可以将您的 MCP 客户端指向dist文件夹。
游标示例:
赞助商
感谢我们的项目赞助商。
黄金赞助商
赞助商助力 EventCatalog 可持续发展,想为项目贡献一份力量吗?欢迎联系我们!或
企业支持
有兴趣与我们合作吗?我们提供专属支持、优先协助、功能开发、定制集成等服务。
请参阅我们的服务页面了解更多详细信息。
执照
此功能的使用是EventCatalog Pro 版本的一部分