Skip to main content
Glama

heartbeat_get

Read-onlyIdempotent

Get one non-deleted heartbeat's configuration, status, and last ping by external GUID in the authenticated organization. Use HeartbeatLogs for actual ping history or HeartbeatIntegrationNotificationsGet for integration routing.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "heartbeatExternalId": "<heartbeatExternalId>"
    },
    "name": "heartbeat_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
heartbeatExternalIdYesExternal heartbeat GUID returned as Id by HeartbeatList; not the internal numeric database ID.

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 already declare read-only, idempotent, non-destructive, closed-world, so the safety profile is covered. The description adds genuinely new behavioral context the annotations cannot convey: results are restricted to non-deleted heartbeats and scoped to the caller's organization. It doesn't say what happens when the GUID is unknown or belongs to another org, which is the one notable gap.

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?

Two sentences, zero filler, and the core action with its scope is front-loaded ahead of the sibling routing. Every clause carries information an agent needs.

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 single-parameter read with no output schema, the description's enumeration of returned fields (configuration, status, last ping) gives the agent enough to know what it gets back. Only the not-found or cross-organization failure mode is left unaddressed.

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 coverage is 100% and the schema already spells out that the value is the external GUID returned as Id by HeartbeatList rather than the internal numeric ID. The description's 'by external GUID' reinforces but does not extend that, 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?

States a specific verb and resource ('Get one non-deleted heartbeat's configuration, status, and last ping'), scopes it to the authenticated organization, and names the key ('external GUID'). It even enumerates the payload an agent receives, which no sibling does.

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?

Explicitly routes the agent away for the two most likely confusions: 'Use HeartbeatLogs for actual ping history or HeartbeatIntegrationNotificationsGet for integration routing.' It lacks a positive statement of when to prefer it over heartbeat_list, but the field enumeration implies that contrast.

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