Skip to main content
Glama

Watch a job with a heartbeat

heartbeat_add

Watch a job (backup, cron run, pipeline) with your heartbeat-monitor. The answer holds ping_url: make the job call it after every run. When a ping is late (period plus grace), we put a message in inbox_instance_id and, with email_owner, email your owner. Up to 10 jobs. Each call adds a new check (hbc_...). For us to check a URL instead, use uptime_add; to change a check, heartbeat_update.

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": {
      "name": "nightly backup",
      "instance_id": "hbt_exampleexampleexample2",
      "period_minutes": 1440,
      "inbox_instance_id": "inb_exampleexampleexample2"
    },
    "name": "heartbeat_add"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesWhat the job is.
email_ownerNoAlso email your owner (only once they confirmed their address).
instance_idYesUtility instance id from buy or list_utilities.
grace_minutesNoExtra time before it counts as late (default 5).
passport_tokenNoYour amp_ token, only if you have no app sign-in and cannot send a header.
period_minutesYesHow often the job runs.
inbox_instance_idNoOne of your inboxes for the alerts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "inbox_instance_id": "inb_exampleexampleexample2",
      +    "instance_id": "hbt_exampleexampleexample2",
      +    "name": "nightly backup",
      +    "period_minutes": 1440
      +  }
      +]
    • 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.8/5.0
Behavior5/5

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

Annotations only declare it is a non-read-only, non-idempotent, open-world write. The description adds real behavior: the response carries ping_url that the job must call after each run, lateness is computed as period plus grace, alerts land in inbox_instance_id and optionally by email, and each invocation creates a new check rather than reusing one.

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?

Four short sentences, front-loaded with purpose and the ping_url obligation, and the sibling routing is placed last where it belongs. The telegraphic style ('period plus grace', 'with email_owner') is dense but each clause carries information; only light polish is missing.

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 no output schema, the description still tells the agent the answer contains ping_url, which is the single most important return detail. It also covers alerting behavior, the 10-check cap, and alternatives, leaving nothing essential an agent needs in order to invoke it correctly.

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 schema already documents each field and the baseline is 3. The description adds relational meaning the schema does not: period_minutes and grace_minutes combine to define 'late', and inbox_instance_id plus email_owner determine alert routing, which raises it above baseline.

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 ('Watch a job ... with your heartbeat-monitor') and immediately disambiguates by naming concrete job types (backup, cron run, pipeline). 'Each call adds a new check (hbc_...)' makes clear this is a creation tool, distinguishing it from heartbeat_update and uptime_add.

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?

Explicit routing to alternatives: 'For us to check a URL instead, use uptime_add; to change a check, heartbeat_update.' It also gives a hard applicability constraint ('Up to 10 jobs'), so the agent knows both when to use it and when not to.

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.