add_ticket_note

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

With no annotations, the description carries the burden. 'Append' conveys a non-destructive, additive write operation, which is helpful. However, it does not disclose potential requirements (e.g., ticket existence, authorization, formatting constraints) or response behavior beyond the append.

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 for purpose plus a compact Args list. No filler or redundant content, and essential parameter details are front-loaded.

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?

Given the tool's simplicity and the presence of an output schema (which removes need to describe return values), the description covers the core purpose and all parameter semantics. It lacks usage guidance and behavioral caveats, but overall it is reasonably complete for a straightforward append operation.

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%, but the description's Args section explicitly explains both parameters: ticket_id is 'the unique numeric ID' (clarifying despite schema string type) and note is 'Text content of the note to append.' This fully compensates for the schema gap.

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 with a specific verb ('Append') and resource ('note to a ticket'). It differentiates from siblings like list_ticket_notes (read operation) and create_ticket/update_ticket (ticket-level operations), making it unambiguous.

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?

No guidance is provided on when to use this tool versus alternatives, nor any context about prerequisites (e.g., ticket must exist) or outcomes. The sibling list is available but the description does not reference it.

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