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.

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.2/5.0
Behavior5/5

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

Beyond the annotations, the description explains the required follow-up: the job must call ping_url after every run. It also discloses alert behavior in detail: late means period plus grace, alerts go to inbox_instance_id, and email_owner optionally emails the owner, plus it states the 10-job quota.

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 purpose and then follows with the operational details an agent needs. It uses four short sentences with no repetition or filler, and every sentence contributes useful information.

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 full schema descriptions and annotations already present, the description fills the remaining behavioral gaps: post-creation ping_url follow-up, alert timing and destinations, and the job quota. It is complete enough for an agent to invoke the tool correctly even without an output schema.

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. The description adds meaningful semantics by explaining that period plus grace determines lateness, that inbox_instance_id receives alerts, and that email_owner controls owner notification, going beyond the individual schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action and resource: watching a job such as a backup, cron run, or pipeline with a heartbeat-monitor. It makes clear this creates a heartbeat watch, but it does not explicitly distinguish itself from sibling tools like heartbeat_update, heartbeat_status, or heartbeat_remove.

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

Usage Guidelines3/5

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

The use case is implied clearly through examples like backup, cron run, and pipeline, and the 'Up to 10 jobs' limit gives a constraint. However, there is no explicit guidance on when to choose heartbeat_add versus heartbeat_update or the other heartbeat siblings, nor any stated exclusion conditions.

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.