Get issue heartbeat context

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds 'Paperclip operation: GET' and 'Authorization class: board_or_agent', which provide additional context but are minor. There is no information about error conditions, return values, or side effects beyond what annotations convey.

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?

The description is very concise (two sentences) but lacks structure. While brevity is valued, the content is minimal and does not front-load the most critical information. The second sentence about Paperclip operation and auth class is partially redundant with annotations and could be omitted or integrated.

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?

Despite having an output schema and annotations, the description is insufficient. It does not clarify what 'heartbeat context' means or what the tool returns. An AI agent would lack sufficient context to understand the tool's role in issue management.

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?

The input schema has 0% description coverage for the single parameter 'id'. The description does not explain what 'id' represents (presumably an issue ID). Given the low schema coverage, the description should compensate by describing the parameter, but it fails to do so.

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?

The description states the tool's purpose as 'Get issue heartbeat context', which is a specific verb and resource. It also includes the HTTP method and path, adding clarity. However, it does not explicitly differentiate from sibling tools like pc_get_issues_by_id or pc_get_issues_by_id_approvals, and the term 'heartbeat context' is not explained.

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?

The description provides no guidance on when to use this tool versus alternatives. It lacks any context for appropriate usage, exclusions, or references to other tools. An AI agent would have no basis to decide when this tool is preferable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.