Skip to main content
Glama
watchgoose-mcp

watchgoose-mcp

Watchgoose MCP

Watchgoose MCP 将支持 MCP 的 AI 客户端连接到 Watchgoose Management API。它可以让你查看 cron 与重复任务的监控情况,并且只有在你显式启用写入时,才可对检查(check)进行更改。

要求

  • Node.js 20 或更高版本

  • 来自项目设置的项目级 Watchgoose API 密钥

当你只需要检查状态和状态历史时,请使用 hcr_ 只读密钥。当你还需要 ping、集成或对检查进行更改时,请使用 hcw_ 读写密钥。

Related MCP server: uptimepage

Claude Desktop

将以下条目添加到 claude_desktop_config.json,然后重启 Claude Desktop:

{
  "mcpServers": {
    "watchgoose": {
      "command": "npx",
      "args": ["-y", "watchgoose-mcp"],
      "env": {
        "WATCHGOOSE_API_KEY": "hcr_your_project_key"
      }
    }
  }
}

Claude Code

claude mcp add --env WATCHGOOSE_API_KEY=hcr_your_project_key \
  --transport stdio --scope user watchgoose -- npx -y watchgoose-mcp

运行 claude mcp get watchgoose 以检查连接。

Cursor

在你的项目中创建 .cursor/mcp.json,或将相同的条目添加到你的用户 MCP 配置中:

{
  "mcpServers": {
    "watchgoose": {
      "command": "npx",
      "args": ["-y", "watchgoose-mcp"],
      "env": {
        "WATCHGOOSE_API_KEY": "hcr_your_project_key"
      }
    }
  }
}

VS Code

创建 .vscode/mcp.json:

{
  "servers": {
    "watchgoose": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "watchgoose-mcp"],
      "env": {
        "WATCHGOOSE_API_KEY": "hcr_your_project_key"
      }
    }
  }
}

运行 MCP: List Servers,然后启动 watchgoose。

环境变量

变量

是否必需

默认值

说明

WATCHGOOSE_API_KEY

是

-

项目级的 hcr_ 只读密钥、hcw_ 读写密钥,或旧版 32 字符密钥。

WATCHGOOSE_API_URL

否

https://watchgoose.com/api/v3

Management API 基础 URL。除回环(loopback)开发主机外,必须使用 HTTPS。密钥会发送到此主机,因此请只使用你信任的 URL。

WATCHGOOSE_ENABLE_WRITES

否

false

当密钥为读写权限时,设置为 true 可暴露变更工具。

WATCHGOOSE_API_KEY_ACCESS

仅旧版密钥需要

-

对于不带前缀的 32 字符密钥,必须设置为 read-only 或 read-write。

服务器会在本地对密钥前缀进行分类,绝不会探测 API 来推断访问权限。设置 WATCHGOOSE_ENABLE_WRITES=true 无法为只读密钥赋予额外的访问权限。

工具

检查使用稳定的 40 字符 unique_key 值来标识。UUID、ping URL 和集成 UUID 仅在服务器内部使用,不会显示给 AI 客户端。

工具

所需访问权限

Management API 映射

list_checks

只读

GET /checks/

get_check

只读

GET /checks/<unique_key>

list_flips

只读

GET /checks/<unique_key>/flips/

list_pings

读写

解析 unique_key,然后 GET /checks/<uuid>/pings/

list_channels

读写

GET /channels/

create_check

读写且已启用写入

POST /checks/

update_check

读写且已启用写入

解析 unique_key,然后 POST /checks/<uuid>

pause_check

读写且已启用写入

解析 unique_key,然后 POST /checks/<uuid>/pause

resume_check

读写且已启用写入

解析 unique_key,然后 POST /checks/<uuid>/resume

delete_check

读写且已启用写入

解析 unique_key,然后 DELETE /checks/<uuid>

集成分配使用确切的集成名称。名称必须非空,并且在项目内唯一。

列表结果的上限为 100 个检查、100 条 ping、200 条 flip 记录和 100 个集成。每个序列化后的工具结果同样以 24,000 字符为上限。当有条目被省略时,结果中会包含相应的元数据。

安全性

  • 即使使用 hcw_ 密钥,写入默认也是禁用的。

  • API 密钥仅通过 X-Api-Key 请求头发送,绝不会被记录或返回。

  • API 重定向会被拒绝,因此凭据不会被转发到其他主机。

  • 检查的 UUID、ping 与更新 URL、集成 UUID,以及未知的未来 API 字段,都会从输出中移除。

  • 每条 ping 仅保留 type、date、n、scheme、method 和 duration。源 IP 地址、用户代理、运行 ID 和请求体 URL 都会被移除。

  • 永远不会请求 ping 的请求体。

  • 服务器不包含任何遥测功能。

请保护包含 API 密钥的客户端配置文件。建议使用专用项目,并选择能提供所需工具的最低权限密钥。当密钥不再使用时,请从 Watchgoose 项目设置中吊销该密钥。

开发

npm install
npm run format:check
npm run lint
npm run typecheck
npm test
npm run publish:dry-run

生产环境集成测试为可选启用(opt-in),需要专用的测试项目密钥。它们绝不会在 CI 中运行。

许可证

MIT

Available Tools

3 tools
get_checkGet a Watchgoose checkA
Read-onlyIdempotent
Inspect

Get one check by its stable unique_key, including its current state and schedule. Cron and OnCalendar checks use schedule plus grace; simple checks use timeout plus grace.

Inputs: unique_key (required). Returns: meta, check

list_checksList Watchgoose checksA
Read-onlyIdempotent
Inspect

List checks in this Watchgoose project, optionally filtered by slug or tags. A successful ping arms a new check; Watchgoose then expects the next success within its timeout or schedule plus grace period.

Inputs: slug, tags, limit. Returns: meta, checks

list_flipsList a check's status changesA
Read-onlyIdempotent
Inspect

List retained status changes for a check, newest first, with optional time filters. In results, up: 1 means the check became up; up: 0 means any other status, including down, paused, and new after resume. A pause or resume that changes the check's status records a flip.

Inputs: unique_key (required), end, limit, start, +1 more. Returns: meta, flips

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

    TDQS

    A4.2/5.0

    Scored across 3 tools

    Disambiguation5/5

    The three tools are clearly distinct: list checks, get a single check by key, and list status changes. There is no meaningful overlap or ambiguity between them.

    Naming Consistency5/5

    All tool names follow a consistent lowercase verb_noun pattern: list_checks, get_check, list_flips. The singular/plural difference is natural and appropriate.

    Tool Count5/5

    Three tools is well-scoped for a read-only monitoring server. Each tool provides a distinct capability with no redundancy or filler.

    Completeness4/5

    The read-only monitoring surface is coherent: discover checks, inspect a check, and view its flip history. Check management and ping actions appear to happen outside MCP, so the lack of mutation tools is a minor gap rather than a fatal one.

    Maintenance

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      C
      maintenance
      MCP server for CronAlert uptime monitoring — manage monitors, check results, and incidents from any MCP-compatible AI client.
      9
      102 npm
      MIT
    • A
      license
      Not graded
      quality
      B
      maintenance
      MCP server for Uptimepage uptime monitoring. An LLM client can read your monitors and incidents, run a check on demand, and post incident updates. Writes need an OAuth login and a scoped token, and each one is logged.
      54
      AGPL 3.0
    • A
      license
      Not graded
      quality
      D
      maintenance
      MCP server for KEEPitALIVE monitoring, enabling AI agents to read and manage monitors, incidents, triggers, and notification routing via the v1 API, with scope-based tool filtering and safety modes.
      7 npm
      1
      MIT
    • A
      license
      Not graded
      quality
      B
      maintenance
      Enables LLM clients to manage Uptime Kuma HTTP(S) monitors, groups, tags, and notifications, and to retrieve heartbeats, stats, and incident history through MCP tools.
      MIT