Waroom MCP

[!CAUTION] 这仍然是一个实验项目，不提供任何稳定性或性能保证。请谨慎使用。

该项目是一个用于与 Waterum API 交互的模型上下文协议 (MCP) 服务器。使用标准化协议，可以从作战室检索各种信息。

概述

Waroom MCP 服务器提供了一种结构化的方式来访问 Waroom API 端点。它支持多种功能，包括获取事件和事后信息。

Related MCP server: Notion MCP Server

如何使用

要启动服务器，请设置必要的环境变量：

export WAROOM_API_KEY=your_api_key

接下来运行以下命令：

npx @topotal/waroom-mcp

这将启动 MCP 服务器并允许您通过定义的工具与 Waterroom API 进行交互。

与 Claude Desktop 一起使用

要将此 MCP 服务器与 Claude Desktop 一起使用，您无需手动运行npx @topotal/waroom-mcp 。相反，将以下内容添加到您的 Claude Desktop 配置文件中：

• MacOS： ~/Library/Application Support/Claude/claude_desktop_config.json

• Windows： %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "waroom-mcp": {
      "command": "npx",
      "args": ["@topotal/waroom-mcp"],
      "env": {
        "WAROOM_API_KEY": "your-api-key"
      }
    }
  }
}

之后，照常启动 Claude Desktop。如果您使用 nodenv 或 nvm，则可能需要指定npx命令的完整路径。

可用工具

该模型上下文协议服务器提供以下与 Waroom 相关的工具：

事件相关

• waroom_get_incidents：获取事件列表

• waroom_get_incident_details：获取特定事件的详细信息

尸检相关

• waroom_get_postmortems：获取验尸报告列表

调试

首先，构建项目：

npm install
npm run build

MCP 服务器通过 stdio 运行，因此调试可能很困难。为了获得最佳调试体验，我们强烈建议使用 MCP Inspector。

您可以使用以下命令通过 npm 启动 MCP Inspector：

npx @modelcontextprotocol/inspector "./dist/main.js"

确保您的环境变量配置正确。

一旦启动，检查器将显示一个 URL，您可以在浏览器中访问该 URL 来开始调试。

发布

要发布软件包的新版本，请按照以下步骤操作：

1. 从主分支拉取最新代码

   git checkout main
   git pull origin main

2. 构建包

   npm run build

3. 发布到 npm

   npm publish

4. 将更改推送到远程存储库

   git push origin main --tags

贡献

欢迎投稿！分叉存储库并提交拉取请求以进行改进和修复错误。

执照

该项目已获得 MIT 许可。请参阅LICENSE文件以了解详细信息。