autotask_search_ticket_attachments

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

No annotations are provided, so the description must fully convey behavioral traits. It reveals that each call is a separate query for one ticket, implying no batch support. However, it does not disclose potential rate limits, authentication requirements, or what happens with invalid ticket IDs. The description adds some value beyond the name but lacks completeness.

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?

The description is two sentences long, both front-loaded and to the point. The first sentence states the purpose, the second provides operational guidance. No unnecessary words or repetition.

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 simple search tool with pagination, the description is mostly complete. It specifies the input (ticketId) and pagination control (pageSize). No output schema exists, but the return format (list of attachments) is implied. The tool is straightforward and the description suffices for correct invocation.

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% (both parameters described inline). The description does not add meaning beyond the schema: 'ticketId' and 'pageSize' are already documented with types, constraints, and defaults. Parameter semantics are adequate but not enhanced by the description.

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 clearly states 'Search for attachments on a specific ticket,' specifying the verb (search) and resource (attachments) and scoping to a single ticket. This distinguishes it from sibling tools like 'autotask_get_ticket_attachment' (get a specific attachment) and 'autotask_create_ticket_attachment' (create).

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 provides explicit guidance: 'Each parent triggers a separate query — scope the parent ticket list before iterating.' This advises when to use the tool (for a specific ticket) and warns against batch processing without iteration. It does not explicitly mention alternatives but offers clear context.

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