get_ticket

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

Lists included data (conversations, attachments, etc.) implying a comprehensive fetch. No annotations, but no contradictions; a simple read operation without side effects.

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?

Single sentence with no wasted words, front-loading the action and including key 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?

Covers purpose, input, and included data adequately for a simple fetch tool. Lacks mention of error handling or pagination, but acceptable given 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?

Schema already provides 100% coverage with examples. Description adds minimal extra value beyond stating input format (URL or ID).

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 specifies the tool's action (fetch complete ticket details) and distinguishes it from siblings like get_agent_tickets and search_tickets by focusing on a single ticket by URL or ID.

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?

Implicitly indicates use when a ticket identifier is known and full details are needed. Sibling names provide context for alternatives, but no explicit when-not-to conditions.

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