comment_on_ticket

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

With no annotations available, the description must cover behavioral context. It does communicate that the operation mutates state by adding a comment, and it includes useful body constraints ('markdown supported, min 1 char'). However, it does not disclose permission requirements, potential side effects, or response behavior; the presence of an output schema partially mitigates the response gap.

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 concise and well-structured: a one-line purpose statement followed by a compact Args block. There is no filler, and every sentence adds useful information for invoking the tool.

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 two-parameter mutation with an output schema and no annotations, the description is largely complete. It defines both parameters, states constraints, and makes the behavior clear. It lacks usage guidance or alternative comparisons, but that gap is already accounted for in the usage_guidelines dimension.

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 by explaining ticket_id as 'the internal ticket id' and body as markdown-supported with a minimum length. This adds meaningful semantics beyond the schema's bare string types and titles.

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 clearly states the action: 'Add a comment to a ticket.' This is a specific verb+resource combination and is unambiguously distinct from sibling tools such as update_ticket, get_ticket, and link_tickets. The tool's purpose is immediately understandable without needing to inspect the schema.

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 about when to use this tool versus alternatives like update_ticket or link_tickets. There is no mention of prerequisites, exclusions, or scenarios where a different ticket-related tool should be preferred. Usage is only implied by the action name rather than explicitly described.

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