EventCatalog 是一个开源工具,帮助您记录事件驱动架构。 使用 EventCatalog,您可以记录您的领域、服务和消息、模式等。
使用 EventCatalog MCP 服务器,您可以通过在已使用的工具中提问来获得更多关于架构的信息。
示例问题:
UserCreated 事件的模式。UserCreated 模式的新版本,这个变化会影响哪些下游消费者?与其深入架构寻找答案,您可以直接向 MCP 服务器提问。
首先,您需要在 EventCatalog 实例中启用 LLMS.txt 功能。
LLMS.txt 功能,通过配置您的 eventcatalog.config.js 文件。LLMS.txt 功能。接下来,您需要获取 EventCatalog Scale 许可密钥,可以从 EventCatalog Cloud 获取 14 天试用许可密钥。
要通过 Smithery 自动安装 EventCatalog for Claude Desktop:
npx -y @smithery/cli install @event-catalog/mcp-server --client claude
每个 MCP 客户端添加 MCP 服务器的方式不同。
以下是一些有用的链接,帮助您开始设置。
要在 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
"ABCD-1234-5678-9012-3456-7890" // 替换为您自己的 EventCatalog Scale 许可密钥
]
}
}
}
进入 Cursor 设置 -> MCP 服务器 -> 添加 MCP 服务器。
eventcatalognpx-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", "ABCD-1234-5678-9012-3456-7890"]
}
}
}
有关项目配置的更多信息,请参阅 Cursor 文档。
以下是 MCP 服务器支持的所有 API 列表。
find_resources
find_resource
find_producers_and_consumers
get_schema
get_schemas
review_schema_changes
explain_ubiquitous_language_terms
find_owners
create_flow
eventcatalog://all
eventcatalog://events
eventcatalog://domains
eventcatalog://services
eventcatalog://queries
eventcatalog://commands
eventcatalog://flows
eventcatalog://teams
eventcatalog://users
我们正在努力增加更多的 API 到 MCP 服务器。如果您需要特定的功能,请 打开一个问题,我们将将其添加到服务器。
pnpm install 安装依赖项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", "ABCD-1234-5678-9012-3456-7890"]
}
}
}
使用此功能是 EventCatalog Scale 计划的一部分。