get_ticket

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

Discloses that comments are omitted by default to save tokens, and that response includes full ticket object plus named_custom_fields. No annotations provided, so description carries burden; it's transparent for a read operation, though could mention behavior if ID not found.

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?

Three sentences, front-loaded with main purpose, no wasted words. Efficiently structured.

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?

Adequately covers key aspects for a simple fetch tool: operation, alternatives, optional parameter behavior. Could be more complete with error handling info, but not essential given schema specifies required.

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%, and description adds meaning: for id, explains how to find it via search; for include_comments, explains default and rationale (save tokens). Adds value beyond schema.

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?

Clearly states 'Fetch one ticket by numeric ID', specifying the verb (fetch), resource (ticket), and unique aspects (full object + named_custom_fields). Distinguishes from siblings like search and get_ticket_comments.

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?

Explicitly tells when to use (numeric ID) and when not (email/subject/tag -> use search). Provides guidance on include_comments: default false to save tokens, and suggests using get_ticket_comments separately if needed.

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