Skip to main content
Glama
mcp-uptime-kuma

mcp-uptime-kuma

Get Push Example

getPushExample
Read-only

Returns ready-to-run code for cron jobs or scripts to report to a created Uptime Kuma push monitor, with its push URL and interval filled in.

Instructions

Returns ready-to-run code that reports to a push monitor every interval, from Uptime Kuma's own samples, with the monitor's push URL and interval filled in. Use it after creating a push monitor, for the user's cron job or script. The push URL holds the monitor's token, a credential: it reads "***" (and the code will not work) unless includeSecrets is set.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "monitorID": "<monitorID>"
    },
    "name": "getPushExample"
  }
}

Input Schema

NameRequiredDescriptionDefault
languageNoOne of bash-curl, csharp, docker, go, java, javascript-fetch, php, powershell, python, typescript-fetch (default: bash-curl)
monitorIDYesThe push monitor. Find IDs with listMonitors.
includeSecretsNoReturn credentials in full instead of "***"; they then stay in the transcript. Default: false, or UPTIME_KUMA_INCLUDE_SECRETS.

Output Schema

NameRequiredDescriptionDefault
codeYes
noteYesWhere the host in the URL came from
pushURLYes
intervalYesSeconds between pushes, from the monitor
languageYes
monitorIDYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.17.0

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the readOnlyHint annotation, the description discloses the critical behavior that the push URL embeds a token credential and is returned as '***' — meaning the emitted code will not work — unless includeSecrets is enabled. That is exactly the kind of non-obvious consequence an agent must know before calling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences with no filler: purpose and provenance first, usage trigger second, credential caveat third. The most decision-relevant warning is present and nothing is repeated from structured fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description needn't explain return values, and it instead covers the two things an agent could get wrong: when to call it and the secret-masking trap. Nothing needed to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaning the schema lacks: the token lives inside the push URL and masking it silently produces non-functional code. Language and monitorID add nothing beyond the schema, keeping it from a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Returns ready-to-run code that reports to a push monitor') plus the exact provenance and scoping ('from Uptime Kuma's own samples, with the monitor's push URL and interval filled in'). The described output is distinct from read-oriented siblings like getMonitor or getMonitorTypeFields, so an agent can identify it without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Use it after creating a push monitor, for the user's cron job or script' gives a clear trigger condition and target audience. It does not name an alternative or state when not to use it, so it stops short of full routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.