kuma MCP

库马-MCP

用于正常运行时间Kuma v2的模型上下文协议（MCP）服务器🐻🤖

此MCP服务器使AI助手能够与Uptime Kuma交互，允许他们管理监控服务、添加/更新/删除监控器以及控制监控器状态。

特性

• 🔐 认证：同时支持用户名/密码和API密钥验证
• 📊 监控管理：添加、更新和删除监视器
• ⏯️ 监视器控制：暂停和恢复监视器
• 📋 监控信息：获取特定监视器的详细信息或列出所有监视器
• 🐳 Docker支持：包括docker-compose.yml，便于Kuma的正常运行时间部署
• 🏗️ TypeScript：完全键入Zod模式验证
• ⚡ 用Bun建造：快速运行时和包管理器（需要Node.js v18+LTS）

安装

先决条件

• 包子 安装在您的系统上
• Node.js v18+LTS
• Uptime Kuma v2实例（可以使用附带的docker compose.yml启动）

再进行

bun install

构建

bun run build

快速开始

1.启动正常运行时间Kuma（可选）

如果您没有运行Uptime Kuma实例，请使用附带的docker compose：

docker-compose up -d

Kuma的正常运行时间将在 http://localhost:3001.转到URL并完成正常运行时间kuma配置。

2.配置环境变量

在中设置凭据 .env:

cp .env.example .env

3.运行服务器

bun run dev

或者使用内置版本：

bun run build
bun dist/index.js

MCP检验员测试

这 MCP检查员 是一个用于测试和调试MCP服务器的可视化工具。它提供了一个交互式界面，用于探索服务器的功能、测试工具和检查响应。

与检查员一起运行

使用Inspector启动MCP服务器：

bunx @modelcontextprotocol/inspector bun run dev

或内置版本

bun run build
bunx @modelcontextprotocol/inspector bun run dist/index.js

检查员将：

1. 启动MCP服务器
2. 打开web界面（通常在 http://localhost:6274)
3. 允许您交互式测试所有可用工具
4. 显示实时请求/响应数据
5. 帮助调试服务器的问题

使用检查器

一旦检查器开始运行：

1. 连接到服务器：检查器会自动连接到您的MCP服务器
2. 浏览工具：查看所有可用工具(add_monitor, list_monitors等）
3. 测试工具：填写参数并执行工具以查看响应
4. 检查结果：查看详细的请求/响应JSON
5. 调试问题：检查错误和验证问题

这对于以下情况特别有用：

• 使用不同配置测试监视器创建
• 验证身份验证是否正常工作
• 探索每个工具的响应格式
• 在与Claude Desktop或其他MCP客户端集成之前调试问题

MCP配置

要将此服务器与Claude Desktop等MCP客户端一起使用，请将其添加到您的MCP配置中：

Claude桌面配置

添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "kuma-mcp": {
      "command": "node",
      "args": ["/path/to/kuma-mcp/dist/index.js"],
      "env": {
        "UPTIME_KUMA_URL": "http://localhost:3001",
        "UPTIME_KUMA_USERNAME": "your-username",
        "UPTIME_KUMA_PASSWORD": "your-password"
        // Alternative: Use API key instead of username/password
        // "UPTIME_KUMA_API_KEY": "your-api-key"
      }
    }
  }
}

可用工具

• add_monitor
• update_monitor
• remove_monitor
• pause_monitor
• resume_monitor
• get_monitor
• list_monitors

api参考

有关正常运行时间Kuma API的更多信息，请参阅：

• 正常运行时间Kuma API文档
• uptime kuma api-uptime kuma Socket的Python包装器。IO API

贡献

欢迎投稿！请随时提交拉取请求。

此项目使用 语义提交消息。参见 贡献.md 详细指南。

许可证

麻省理工学院

参考文献

• 模型上下文协议
• 在线时间监控熊
• 正常运行时间Kuma API文档