heartbeats_list
Get a list of all heartbeats configured for a log, including their current status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| logId | Yes | The ID (Guid) of the log. |
Get a list of all heartbeats configured for a log, including their current status.
| Name | Required | Description | Default |
|---|---|---|---|
| logId | Yes | The ID (Guid) of the log. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds only that returned heartbeats include their current status; it says nothing about pagination, ordering, or what happens for a log with no heartbeats.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single tight sentence with the resource and scope front-loaded and no filler. It is appropriately sized for a simple list tool, though it sacrifices some detail for brevity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter read-only list operation with full annotation coverage and no output schema, the definition plus schema give enough to invoke it correctly. Only minor gaps remain around ordering/pagination and absent-result behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single logId parameter is fully documented in the schema as a Guid. The description's phrase 'configured for a log' merely restates that linkage, adding no syntax or format detail beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Specific verb+resource: lists heartbeats configured for a log and mentions it includes current status. It is reasonably distinguishable from the sibling heartbeats_get_details, though the description never explicitly contrasts the two.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use or when-not-to-use guidance. The sibling heartbeats_get_details exists and an agent has to infer the split (list vs. single-detail) from names alone, with no routing condition stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.