autotask_get_ticket_details

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

No annotations provided, so the description carries full burden. It does not disclose expected behavior (e.g., read-only, error handling, rate limits) or any side effects beyond stating it retrieves details.

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 of 9 words, no fluff, front-loaded with the key action and resource. All information is essential.

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 get-by-ID tool without output schema, the description mentions key components of the returned data (notes, time entries, custom fields), which is sufficient context. Could briefly mention ID uniqueness or non-pagination.

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 describes both parameters with clear semantics. The tool description adds context about what 'full details' includes (notes, time entries, custom fields), complementing the schema's default value explanation.

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 uses a specific verb-resource combination ('Get full ticket details') and lists included elements (notes, time entries, custom fields), clearly distinguishing it from sibling search tools like autotask_search_tickets.

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 implies usage for retrieving full details of a specific ticket, but provides no explicit guidance on when to use vs. alternatives (e.g., autotask_search_tickets for summary) or exclusion criteria.

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