Skip to main content
Glama

Change, pause or resume a heartbeat check

heartbeat_update
DestructiveIdempotent

Change a heartbeat check (name, period, grace, inbox, email_owner), or pause it (never alerts) or resume it (a fresh 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.

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

A3.7/5.0
Behavior1/5

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

The annotations declare idempotentHint=true, but the description says resume sets 'a fresh deadline from now' and period/grace can count from now while waiting; repeated identical calls would therefore shift deadlines and have additional effects. That directly contradicts the idempotency annotation, so the description cannot be credited for behavioral transparency despite otherwise rich incident and down-check details.

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

Conciseness4/5

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

The main operation is front-loaded and the added sentences carry important caveats rather than boilerplate. The final sentence is dense with nested parentheticals, but overall it remains appropriately sized for a complex mutation.

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

Completeness4/5

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

For a 9-parameter mutation with no output schema, the description covers the critical state transitions, incident behavior, and down-check recovery limits. It leaves some gaps around auth/passport usage and explicit sibling routing, but schema and annotations fill most of those.

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 parameter documentation is already strong. The description still adds useful semantics for period_minutes/grace_minutes (count from last ping, from now while waiting, due immediately if elapsed) and status (pause never alerts; resume gives a fresh deadline), beyond the schema text.

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 uses a specific verb ('Change') and resource ('heartbeat check'), enumerates editable fields, and separately names pause/resume modes. This makes clear it is the update operation, not heartbeat_add, heartbeat_remove, heartbeat_status, or heartbeat_test.

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?

It clearly distinguishes changing from pausing and resuming, and warns that changing a down check does not recover it because only a real ping does. It does not explicitly name sibling alternatives such as heartbeat_add or heartbeat_remove, so it falls short of full when/when-not routing.

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.