关于 TalkEventsToMe
TalkEventsToMe 是一个学习项目,展示 Cursor 等兼容 MCP 的客户端如何查询组织的 EventCatalog,了解事件驱动架构。它通过 EventCatalog MCP Server 探索资源、模式、归属关系和事件流。
主要功能
- 01通过 MCP 查询 EventCatalog
- 02查找资源及详细记录
- 03检查模式和模式变更
- 04探索生产者、消费者与事件流
- 05解释领域术语
适用场景
- 01查找事件的归属团队和消费者
- 02检查模式变更是否存在破坏性影响
- 03了解服务与事件之间的关系
MCP 相关
项目配置 @eventcatalog/mcp-server,供 Cursor 等兼容 MCP 的客户端使用。它提供 EventCatalog 的发现、模式检查和术语解释工具,以及目录资源。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
TalkEventsToMe
一个学习项目,重点是通过 MCP(Model Context Protocol)服务与 EventCatalog 集成,探索事件驱动架构相关的问题和见解。
🎯 项目目的
本项目演示如何利用 EventCatalog MCP Server,与组织的 EventCatalog 实例交互,并直接从 Claude、Cursor 和 Windsurf 等 AI 助手获取有关事件驱动架构的见解。
🏗️ 架构概览
- EventCatalog 实例:https://eventcatalog.compassdigital.org/(受 Google OAuth 保护)
- MCP 服务:@eventcatalog/mcp-server
- 客户端:集成 MCP 的 Cursor IDE
- 身份验证:需要 EventCatalog Scale 许可证密钥
🚀 设置说明
先决条件
-
EventCatalog Scale 许可证:你需要 EventCatalog Scale 的许可证密钥
- 从 EventCatalog Cloud 获取 14 天试用
- 替换
.mcp.json中的YOUR_EVENTCATALOG_SCALE_LICENSE_KEY
-
访问 EventCatalog 实例:确保你有权访问 https://eventcatalog.compassdigital.org/
安装
- 配置 MCP 服务:
.mcp.json文件已为此项目配置完毕 - 安装依赖项:MCP 服务将通过 npx 自动安装
- 重启 Cursor:更新
.mcp.json后,重启 Cursor 以加载 MCP 服务
验证
完成配置后,你应该能在 Cursor 中看到可用的 EventCatalog MCP 服务。你可以通过询问有关事件目录的问题来验证。
🤖 可用的 MCP 工具
EventCatalog MCP 服务提供以下工具:
工具
find_resources- 查找 EventCatalog 中可用的资源find_resource- 获取有关服务、领域、事件、命令、查询或流程的详细信息find_producers_and_consumers- 获取某个服务的生产者和消费者get_schema- 返回服务、事件、命令或查询的架构review_schema_changes- 检查架构变更是否会造成破坏性影响explain_ubiquitous_language_terms- 解释领域专用术语
资源
eventcatalog://all- 所有消息、领域和服务eventcatalog://events- 所有事件eventcatalog://domains- 所有领域eventcatalog://services- 所有服务eventcatalog://queries- 所有查询eventcatalog://commands- 所有命令eventcatalog://flows- 所有流程eventcatalog://teams- 所有团队eventcatalog://users- 所有用户
🔍 学习问题
以下是本项目旨在探索的关键问题:
菜单发布事件
- 发布新菜单时是否会触发事件?
- 该事件由哪个团队负责?
- 如何订阅该事件?
- 处理该事件需要了解哪些信息?
- 还有哪些与菜单服务相关的事件?
事件注册与发现
- 我有自己的服务,如何在 eventcatalog 中注册新事件?
- 注册新事件时是否需要通知某人?其他人如何订阅我的事件?
架构见解
- 是否有关于我们事件驱动架构的信息?
- 能否创建一个事件流,展示菜单发布时的情况以及该事件的所有订阅者?
错误处理与可靠性
- 如果事件传递失败,订阅者如何得知这一情况?
🎓 学习目标
通过本项目,你将了解:
- 如何配置 MCP 服务以集成 EventCatalog
- 如何以编程方式查询事件驱动架构文档
- 如何发现架构中的事件、架构和关系
- 如何了解团队的归属与职责
- 如何识别事件流和依赖关系
- 如何探索错误处理和可靠性模式
📚 资源
🔧 故障排除
常见问题
- 许可证密钥问题:确保你的 EventCatalog Scale 许可证密钥有效且未过期
- 网络访问:确认你可以通过网络访问 EventCatalog 实例
- OAuth 问题:确保你已通过 Google OAuth 对 EventCatalog 实例完成身份验证
- MCP 服务未加载:修改
.mcp.json后重启 Cursor
调试命令
# Test MCP server installation
npx -y @eventcatalog/mcp-server --help
# Verify EventCatalog accessibility
curl -I https://eventcatalog.compassdigital.org/
📝 备注
- 本项目旨在用于学习和探索
- EventCatalog 实例受 Google OAuth 保护
- 完整使用功能需要 EventCatalog Scale 许可证
- MCP 集成可与 Claude、Cursor、Windsurf 及其他兼容 MCP 的客户端配合使用
🤝 贡献
这是一个个人学习项目,但欢迎你:
- 添加更多示例问题
- 记录有趣的发现
- 分享有关事件驱动架构模式的见解
- 改进设置文档
📄 许可证
本项目仅用于教育目的。请遵守 EventCatalog 及相关工具的许可条款。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。