Skip to main content
Glama

Change, pause or resume a heartbeat check

heartbeat_update
Destructive

Change a heartbeat check or pause it (never alerts) or resume it (a fresh deadline from now); pausing or resuming again changes nothing, but a repeat call is not a no-op: the same period or grace again moves a waiting check's deadline. A new period or grace counts from the last ping (from now while waiting; due at once if that already ran out). Only a real ping recovers a down check: changing it keeps it down with its open incident and sends no up message (pausing closes the incident, also without one), and the new period and grace count from the ping that ends it. An unknown heartbeat_id answers heartbeat_not_found; heartbeat_remove stops watching for good.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "instance_id": "hbt_exampleexampleexample2",
      "heartbeat_id": "hbc_exampleexampleexample2",
      "period_minutes": 60
    },
    "name": "heartbeat_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew label.
statusNopaused: never alerts; active: a fresh deadline from now.
email_ownerNoOwner emails on or off.
instance_idYesUtility instance id from buy or list_utilities.
heartbeat_idYesheartbeat id (hbc_...) from heartbeat_add or heartbeat_status.
grace_minutesNoNew grace in minutes.
passport_tokenNoYour amp_ token, only if you have no app sign-in and cannot send a header.
period_minutesNoNew period in minutes.
inbox_instance_idNoAnother inbox, or null for none.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "heartbeat_id": "hbc_exampleexampleexample2",
      +    "instance_id": "hbt_exampleexampleexample2",
      +    "period_minutes": 60
      +  }
      +]
    • changedInput schema / properties / passport_token / description
      Previous value: -"Your amp_ token, only if your app has no sign-in and cannot send it as an Authorization header."New value: +"Your amp_ token, only if you have no app sign-in and cannot send a header."
  2. Changed4 schema fields changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / passport_token / description
      Previous value: -"Your amp_ token, only if your client cannot send it as an Authorization header; leave it out when your MCP app signed in."New value: +"Your amp_ token, only if your app has no sign-in and cannot send it as an Authorization header."
    • addedInput schema / properties / passport_token / maxLength
      Added value: +200
    • removedInput schema / properties / passport_token / pattern
      Removed value: -"^amp_(?:s_)?[A-Za-z0-9_-]{43}$"
  3. Added

TDQS

A4.7/5.0
Behavior5/5

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

Goes well past the destructiveHint/idempotentHint annotations by disclosing exactly what state changes and what is preserved: a down check stays down with its open incident and no up message, while pausing closes the incident without an up message. It also resolves the non-obvious idempotency edge case (a repeat call is not a no-op for period/grace because the deadline moves).

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

Conciseness3/5

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

It is front-loaded with the core action and every clause carries information, but it is delivered as one dense run-on with stacked parentheses that an agent must parse carefully. A short bulleted split by mode would preserve the content with far less reading friction.

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?

For a destructive, non-idempotent 9-parameter mutation with no output schema, the description covers the mutation effects, the incident/alert consequences, the error case, and the adjacent tool. Nothing an agent needs to invoke this safely 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 real semantics the schema lacks: a new period or grace counts from the last ping, from now while waiting, and is due at once if the window already ran out. It does not explain email_owner, inbox_instance_id, or passport_token, which stays schema-only.

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 (change, pause, resume) against a specific resource (heartbeat check), and explicitly contrasts with heartbeat_remove ("stops watching for good"). An agent can distinguish this from heartbeat_add/heartbeat_remove without opening any schema.

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?

Gives explicit when-to guidance per mode: pause means never alerts, resume means a fresh deadline from now, and only a real ping can recover a down check. It also names the alternative behavior (heartbeat_remove) and the failure path (unknown heartbeat_id answers heartbeat_not_found).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.