Skip to main content
Glama

Update check

update_check
Idempotent

Modify an existing uptime check by UID or slug using PATCH semantics: pass only fields to change, such as name, interval, regions, labels, enabled status, or incident thresholds.

Instructions

Update an existing check by UID or slug and return the updated check. PATCH semantics — only the fields you pass are modified, others stay as-is. Use create_check to make a new check and delete_check to remove one; to pause without deleting, set enabled:false instead. Modifies the check in place without consuming quota; reversible by updating again with the previous values. Requires the mcp scope (mcp:read tokens are refused) and at least the user role in the organization.

Input Schema

NameRequiredDescriptionDefault
nameNoNew human-readable name, e.g. "API production".
slugNoNew URL-friendly slug, e.g. "api-prod".
configNoReplace check-specific config (full object — not merged).
labelsNoReplace labels object (empty object clears all). Example: {"env":"staging"}.
periodNoNew check interval as HH:MM:SS, e.g. "00:00:30" for 30 seconds.
enabledNoToggle whether the check runs. Set to false to pause the check, true to resume it.
regionsNoPin the check to exactly these regions, e.g. ["eu-west-1","us-east-1"] (placement becomes "pinned"). An empty array puts the check back on the default placement: automatic across regionCount healthy regions (unless the org's own default_regions names a private location, which pins it to those defaults). The check keeps running either way; use enabled: false to stop it.
placementNoSwitch the placement: "auto" lets the scheduler place the check (keeping its current region count and every current region still healthy) and move it off a region that goes dark; "pinned" freezes the current regions unless regions is also given.
failQuorumNoMulti-region quorum: how many of the check's regions must be failing, for the confirmation period, before it is down and an incident opens. "all", "majority" or a whole number such as "2" (clamped to the region count). The default is all regions for 1-2 regions and a majority for 3+. Fewer failing regions than the quorum is a "regional issue": the check shows warning and no incident opens. "all" keeps the per-result rule: any passing region resets the confirmation. Pass "default" to put the check back on the default.
identifierYesCheck UID or URL-friendly slug, e.g. "api-prod" or "63d49e55-97e3-4e8c-b7ab-c862de7a43f3".
regionPoolNoAutomatic placement only: candidate cloud region slugs; an empty array means any. Implies placement auto.
descriptionNoUpdated free-text description shown in the UI.
regionCountNoAutomatic placement only: how many regions run the check. Implies placement auto.
checkGroupUidNoMove to a different group (UID or slug). Pass an empty string to ungroup.
resolveOpenIncidentsNoWith enabled:false, also close the check's open incidents (resolution type check_disabled).
recoveryPeriodSecondsNoWall-clock seconds the check must stay UP before auto-resolving. Any failure inside the window resets the recovery clock. 0 = resolve immediately. Range 0–86400.
confirmationPeriodSecondsNoWall-clock seconds to wait after the first failure before opening an incident. 0 = open immediately. Range 0–86400 (one day).

Output Schema

NameRequiredDescriptionDefault
uidYesCheck UID.
nameNoHuman-readable name.
slugNoURL-friendly slug.
typeNoCheck type, e.g. "http".
configNoCheck-specific configuration for the type.
labelsNoKey-value labels.
periodNoCheck interval as HH:MM:SS.
statusNoSynthesized status: up, down, validating, created or degraded.
enabledNoWhether the check runs.
regionsNoRegions the check runs from.
createdAtNoRFC3339 creation timestamp.
placementNo"pinned" or "auto".
descriptionNoFree-text description.
lastResultAtNoRFC3339 timestamp of the newest real result.
checkGroupUidNoCheck group UID, when the check belongs to a group.
statusChangedAtNoRFC3339 timestamp of the last status change.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv0.42.0
    • addedInput schema / properties / checkGroupUid / maxLength
      Added value: +2048
    • addedInput schema / properties / description / maxLength
      Added value: +2048
    • addedInput schema / properties / failQuorum / maxLength
      Added value: +2048
    • addedInput schema / properties / identifier / maxLength
      Added value: +2048
    • addedInput schema / properties / identifier / minLength
      Added value: +1
    • addedInput schema / properties / name / maxLength
      Added value: +2048
    • addedInput schema / properties / period / maxLength
      Added value: +2048
    • addedInput schema / properties / placement / maxLength
      Added value: +2048
    • addedInput schema / properties / resolveOpenIncidents
      Added value: +{
      +  "description": "With enabled:false, also close the check's open incidents (resolution type check_disabled).",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / slug / maxLength
      Added value: +2048
  2. Changed2 schema fields changedv0.41.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedOutput schema / additionalProperties
      Added value: +false
  3. Changed7 schema fields changedv0.38.5
    • changedInput schema / properties / enabled / description
      Previous value: -"Toggle whether the check runs."New value: +"Toggle whether the check runs. Set to false to pause the check, true to resume it."
    • addedInput schema / properties / failQuorum
      Added value: +{
      +  "description": "Multi-region quorum: how many of the check's regions must be failing, for the confirmation period, before it is down and an incident opens. \"all\", \"majority\" or a whole number such as \"2\" (clamped to the region count). The default is all regions for 1-2 regions and a majority for 3+. Fewer failing regions than the quorum is a \"regional issue\": the check shows warning and no incident opens. \"all\" keeps the per-result rule: any passing region resets the confirmation. Pass \"default\" to put the check back on the default.",
      +  "type": "string"
      +}
    • addedInput schema / properties / placement
      Added value: +{
      +  "description": "Switch the placement: \"auto\" lets the scheduler place the check (keeping its current region count and every current region still healthy) and move it off a region that goes dark; \"pinned\" freezes the current regions unless regions is also given.",
      +  "type": "string"
      +}
    • addedInput schema / properties / regionCount
      Added value: +{
      +  "description": "Automatic placement only: how many regions run the check. Implies placement auto.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / regionPool
      Added value: +{
      +  "description": "Automatic placement only: candidate cloud region slugs; an empty array means any. Implies placement auto.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / regions / description
      Previous value: -"Replace region list, e.g. [\"eu-west-1\",\"us-east-1\"]. Pass an empty array to run from no regions (effectively pauses execution)."New value: +"Pin the check to exactly these regions, e.g. [\"eu-west-1\",\"us-east-1\"] (placement becomes \"pinned\"). An empty array puts the check back on the default placement: automatic across regionCount healthy regions (unless the org's own default_regions names a private location, which pins it to those defaults). The check keeps running either way; use enabled: false to stop it."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "checkGroupUid": {
      +      "description": "Check group UID, when the check belongs to a group.",
      +      "type": "string"
      +    },
      +    "config": {
      +      "description": "Check-specific configuration for the type.",
      +      "type": "object"
      +    },
      +    "createdAt": {
      +      "description": "RFC3339 creation timestamp.",
      +      "type": "string"
      +    },
      +    "description": {
      +      "description": "Free-text description.",
      +      "type": "string"
      +    },
      +    "enabled": {
      +      "description": "Whether the check runs.",
      +      "type": "boolean"
      +    },
      +    "labels": {
      +      "description": "Key-value labels.",
      +      "type": "object"
      +    },
      +    "lastResultAt": {
      +      "description": "RFC3339 timestamp of the newest real result.",
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "Human-readable name.",
      +      "type": "string"
      +    },
      +    "period": {
      +      "description": "Check interval as HH:MM:SS.",
      +      "type": "string"
      +    },
      +    "placement": {
      +      "description": "\"pinned\" or \"auto\".",
      +      "type": "string"
      +    },
      +    "regions": {
      +      "description": "Regions the check runs from.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "slug": {
      +      "description": "URL-friendly slug.",
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "Synthesized status: up, down, validating, created or degraded.",
      +      "type": "string"
      +    },
      +    "statusChangedAt": {
      +      "description": "RFC3339 timestamp of the last status change.",
      +      "type": "string"
      +    },
      +    "type": {
      +      "description": "Check type, e.g. \"http\".",
      +      "type": "string"
      +    },
      +    "uid": {
      +      "description": "Check UID.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "uid"
      +  ],
      +  "type": "object"
      +}
  4. First observedv0.32.1

TDQS

A4.9/5.0
Behavior5/5

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

The description adds substantial behavior beyond the annotations: PATCH semantics, in-place modification, no quota consumption, reversibility, and required mcp scope plus user role. These details are directly useful for safe invocation and are consistent with the readOnly=false and destructive=false annotations.

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?

The description is front-loaded with the core action and scope, then covers alternatives, side effects, and auth requirements in a compact form. Every sentence contributes useful operational context for a 17-parameter mutation tool.

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?

Given the rich input schema, output schema, and annotations, the description supplies the remaining high-value context: PATCH behavior, safety, quota impact, reversibility, and authorization. Nothing essential for correct tool selection or invocation 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 individual parameter descriptions already carry most semantics. The description still adds meaningful cross-parameter behavior by stating PATCH semantics: only passed fields are modified and all others remain unchanged.

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?

The description states a specific verb and resource: update an existing check by UID or slug and return the updated check. It also explicitly distinguishes this tool from create_check and delete_check, so an agent can identify its role among siblings without inspecting schemas.

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

Usage Guidelines5/5

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

It gives explicit alternatives: create_check for new checks, delete_check for removal, and enabled:false for pausing without deleting. That covers the main decision points an agent needs before choosing this tool.

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