gorelo_get_ticket_comment

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

With no annotations, the description carries the full behavioral burden. It adds a meaningful behavioral detail: the response includes the full BodyHtml and omits the BodyTruncated flag. It does not cover error handling or authentication, but for a simple read operation this is reasonably transparent.

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?

Two short sentences, with the core purpose front-loaded and the return-value detail added in the second sentence. Every word contributes, with no filler or repetition.

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 simple single-resource getter with two obvious parameters, the description is nearly complete. It states the exact scope and the key output characteristic (full BodyHtml). It could mention the absence of an output schema, but the description already tells the agent what to expect in the response.

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 description coverage is 0%, so the description must compensate. It does not explain what ticketId and commentId represent beyond their names or how to obtain them. The resource name implies ticket and comment identifiers, but no format, source, or relationship guidance is provided.

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?

Uses a specific verb and resource: 'Get a single comment on a ticket.' It is immediately distinguishable from sibling gorelo_list_ticket_comments, which retrieves multiple comments, and from gorelo_get_ticket, which targets the ticket rather than the comment.

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 implies the use case: retrieve one specific comment by ID rather than listing all comments. However, it does not explicitly state when to choose this tool over get_ticket or list_ticket_comments, nor does it mention any prerequisites or exclusions.

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