autotask_get_ticket_details

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

Description discloses what the tool returns (notes, time entries, custom fields), but no annotations exist and it does not mention permissions, side effects, or request behavior; minimal transparency beyond the name.

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 that concisely states purpose and includes key return components; no unnecessary words, front-loaded.

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?

Tool has 2 parameters and no output schema; description covers purpose but does not explain the fullDetails parameter or return structure; adequate but not complete for a tool with no annotations.

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 already describes both parameters; the description adds no new parameter-level information beyond the schema, meeting the baseline without enhancement.

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 verb 'Get' and resource 'full ticket details', and specifies included components (notes, time entries, custom fields), distinguishing it from sibling tools that retrieve specific parts of 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?

No explicit guidance on when to use this tool versus alternatives like autotask_get_ticket_note or autotask_search_tickets; usage is only implied through the description.

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