Skip to main content
Glama

Send a test alert to a heartbeat check's inbox

heartbeat_test

Put one test alert (event "test") in a heartbeat check's inbox, to check your handling before a job really stops. Never an email; the check is untouched.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
instance_idYesUtility instance id from buy or list_utilities.
heartbeat_idYesheartbeat id (hbc_...) from heartbeat_add or heartbeat_status.
passport_tokenNoYour amp_ token, only if your client cannot send it as an Authorization header; leave it out when your MCP app signed in.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-destructive, non-idempotent write, which is a slightly ambiguous profile; the description resolves it by stating the check itself is untouched and no email is ever sent, clarifying that the only side effect is a queued inbox alert. It does not address repeat-call behavior (non-idempotent), which is the one trait annotations leave open.

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?

A single sentence with the action front-loaded and the caveats ('Never an email; the check is untouched') trailing compactly. No filler.

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?

With no output schema, an agent could still want to know what the call returns or how to observe the test alert in the inbox, which is not stated. The safety profile and effect are otherwise fully covered for this simple two-required-parameter tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and each parameter already documents its source (instance_id from buy/list_utilities, heartbeat_id from heartbeat_add/status, passport_token header fallback). The description adds nothing about the parameters, so the baseline 3 applies.

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 names a concrete verb and resource ('Put one test alert ... in a heartbeat check's inbox') and pins the payload to the 'test' event, which cleanly separates it from a real heartbeat alert or the generic inbox_* tools.

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 gives a clear when-to-use rationale ('to check your handling before a job really stops'), which tells the agent this is a dry-run/preflight step. It does not name exclusions or point at heartbeat_add/heartbeat_status as alternatives, so it falls short of a 5.

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.

Resources