create_ticket_comment

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

Discloses that for customers comments are always public, and for employees the private flag controls internal notes. Adds context beyond annotations, which only indicate read/write and destructiveness.

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 sentences, front-loaded with purpose and then behavioral nuance. No unnecessary words.

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?

Covers essential behavioral differences and parameter roles. Lacks mention of return value or success indication, but given no output schema, this is minor.

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 coverage is 100% with descriptions, so description adds minimal extra value. The description reinforces the private flag behavior already in schema, but includes role-based 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?

Description clearly states verb 'adds' and resource 'comment to existing support ticket'. It distinguishes from sibling tools like list_ticket_comments (lists) and create_ticket (creates 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?

Describes when to use (to add comment) and includes context about public vs private for customers vs employees. Does not explicitly state when not to use or mention alternatives like list_ticket_comments.

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