Add internal note to a Ticket

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

No annotations are provided, so the description carries the full burden. It discloses the visibility of the note, the plain-text requirement for content, and the potential ValueError for invalid arguments. It also mentions the return value structure. This is solid transparency for a simple create-like operation, though it does not cover authorization or rate limits.

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 well-structured with Args, Returns, and Raises sections. It is appropriately sized and each section earns its place. The Args section adds value with additional constraints beyond the schema, and the Returns/Raises sections provide essential invocation details.

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 tool with no output schema, the description includes return and error behavior, making it complete for invocation. It also clarifies the internal visibility distinction. Minor gaps include lack of explicit prerequisites or prerequisites for operator_id, but overall it is sufficiently complete for the tool's simplicity.

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?

Although schema description coverage is 0%, the description adds meaning to parameters: ticket_id is 'the ID of the ticket', content 'must be plain text', and operator_id is 'the UUID of the operator'. This goes beyond the schema's bare types and titles, providing useful constraints and context.

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 tool's purpose: adding an internal note to a specific ticket. It specifies the visibility (operators only, not sent to customer), which distinguishes it from sibling tools like 'reply_to_a_ticket'.

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 context on when to use this tool by clarifying that the note is internal-only and not customer-facing. This implies it should be used instead of reply_to_a_ticket when the message is not meant for the customer. It does not explicitly name alternatives, but the context is clear.

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