Skip to content

MCP tool reference

The server defines 20 tools. Discovery returns the subset permitted by the connection’s current primary scopes. Arguments are strict objects: unknown fields are rejected. Use the live tools/list schemas for machine validation.

The operation map lists every primary scope and REST equivalent. MCP arguments use the names below, not REST path/query envelopes.

Tool Required arguments Optional arguments Output reference
get_account_capabilities None ({}) None Capabilities
list_checks None limit, cursor, q, status, kind Check page envelope
get_check id None Check resource
create_check check, idempotency_key None at top level Check inputs/output
update_check id, check None at top level Check inputs/output
get_check_ping_urls id None Sensitive locations
get_check_history id days Daily history
list_check_runs id days, limit, cursor Run page
get_check_metrics id days, probe_id, resolver_id (at most one source) Latency metrics
get_check_uptime id days Uptime
list_incidents None check_id, state, days, limit, cursor Incident page
get_incident id None Incident resource
list_notification_groups None limit, cursor Group page
list_dashboards None limit, cursor Dashboard summaries
get_dashboard id limit, cursor Dashboard detail
create_dashboard dashboard, idempotency_key None at top level Dashboard inputs/output
update_dashboard id, dashboard None at top level Dashboard inputs/output
attach_check_to_dashboard dashboard_id, check_id None ID pair
detach_check_from_dashboard dashboard_id, check_id None ID pair
reorder_dashboard_checks dashboard_id, check_ids group_id Order output

Defaults: limit 20, cursor zero, days 30. Limits: limit 1-100, cursor >=0, days seven/30. IDs are nonempty strings <=100 characters. Idempotency keys are nonempty strings <=100. Array and per-kind constraints are in the linked references.

Arguments for get_check_uptime:

{
"id": "check_EXAMPLE",
"days": 7
}

Arguments for create_check:

{
"check": {
"name": "Nightly backup",
"kind": "ping",
"schedule_type": "interval",
"interval_seconds": 86400,
"grace_period_seconds": 600,
"failing_threshold": 1
},
"idempotency_key": "backup-check-001"
}

Arguments for attach_check_to_dashboard:

{
"dashboard_id": "dash_EXAMPLE",
"check_id": "check_EXAMPLE"
}

Use actual returned IDs. The HTTP Idempotency-Key header is not used in MCP; the key is a tool argument.

Successful tool results include structured content conforming to the operation’s output and JSON text content. Domain errors are error-marked tool results with an error object, not successful empty resources. Transport or protocol errors are a separate layer.

Do not announce a create succeeded after a quota, scope or validation error. See API errors for common codes and billing guidance.

The seven write tools are create/update check, create/update dashboard, attach, detach and reorder. Creating/check assignment also requires the relevant nested assignment scopes.

Create dashboard is private. Update, detach and reorder require private custom dashboards; attach can affect a published custom dashboard, so review public disclosure before assigning checks. Reorder requires every group member exactly once and cannot move checks across groups.

There are no tools for deletion, publishing, public branding, account management, purchase, check-kind change, pause/resume or incident-note writing. Heartbeat URL retrieval is technically a read but returns operational credentials and requires explicit sensitive scope.