事件目录集成工具

一个学习项目,专注于通过MCP服务器与EventCatalog集成,探索事件驱动架构的问题和见解。

  • by chiefnamingofficer
  • Shell
  • 本地部署
  • 更新于
在 GitHub 查看 chiefnamingofficer/talkeventstome

使用说明

TalkEvents To Me

一个学习项目,重点是通过MCP(模型上下文协议)服务器与EventCatalog集成,以探索事件驱动的架构问题和见解。

🎯 项目目的

该项目演示了如何利用 事件目录MCP服务器 与我们组织的EventCatalog实例交互,并直接从Claude、Cursor和Windsurf等人工智能助手那里了解我们的事件驱动架构。

🏗️ 架构概述

  • 事件目录实例: https://eventcatalog.compassdigital.org/(谷歌OAuth保护)
  • MCP服务器:@eventcatalog/mcp服务器
  • 客户端:带MCP集成的游标IDE
  • 认证:需要EventCatalog Scale许可证密钥

🚀 安装说明

先决条件

  1. EventCatalog规模许可证:您需要EventCatalog Scale的许可证密钥

    • 从以下网址获得14天试用期 事件目录云
    • 替换 YOUR_EVENTCATALOG_SCALE_LICENSE_KEY 在……里面 .mcp.json
  2. 访问EventCatalog实例:确保您有权访问https://eventcatalog.compassdigital.org/

安装

  1. 配置MCP服务器:The .mcp.json 文件已为此项目配置
  2. 再进行:MCP服务器将通过npx自动安装
  3. 重新启动游标:更新后 .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 -所有用户

🔍 学习问题

以下是本项目旨在探索的关键问题:

菜单发布事件

  1. 新菜单发布时是否有事件?
  2. 哪支球队拥有这场比赛?
  3. 我如何订阅该活动?
  4. 为了处理该事件,我需要知道什么?
  5. 还有哪些与菜单服务相关的事件?

活动注册和发现

  1. 我有自己的服务,如何在事件目录中注册新事件?
  2. 我需要在注册新活动时通知某人吗?他们如何订阅我的活动?

架构洞察

  1. 是否有关于我们的事件驱动架构的信息?
  2. 您是否可以创建一个事件流,显示菜单何时发布以及该事件的所有订阅者是谁?

错误处理和可靠性

  1. 如果事件未能送达,订阅者将如何了解这种情况?

🎓 学习目标

通过这个项目,你会学到:

  • 如何为EventCatalog集成配置MCP服务器
  • 如何以编程方式查询事件驱动架构文档
  • 如何发现架构中的事件、模式和关系
  • 如何理解团队所有权和责任
  • 如何识别事件流和依赖关系
  • 如何探索错误处理和可靠性模式

📚 资源

🔧 故障排除

常见问题

  1. 许可证密钥问题:确保您的EventCatalog Scale许可证密钥有效且未过期
  2. 网络接入:验证您是否可以从网络访问EventCatalog实例
  3. OAuth问题:确保您已通过EventCatalog实例的Google OAuth身份验证
  4. MCP服务器未加载:修改后重新启动游标 .mcp.json

调试命令

# 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和相关工具的许可条款。