autotask_get_ticket_attachment

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

Disclosures include endpoint behavior, base64 encoding, stripping oversized binaries with dataOmittedReason, attachment verification, and size limits. No annotations provided, so description fully covers behavioral traits.

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?

Concise with clear structure: function, mode behaviors, verification, and size handling. No unnecessary words.

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?

Thoroughly explains return format, parameter effects, and edge cases (oversized files, verification). No output schema, but description covers needed context.

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% (baseline 3). Description adds value by explaining return behavior for includeData and default cap for maxInlineBase64Bytes with client-limit warning.

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 it retrieves a ticket attachment, distinguishes between metadata-only and full-data retrieval via includeData flag, and verifies attachment belongs to ticketId. It differentiates from sibling search tool.

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 advises using includeData=false for browsing and includeData=true for content, warns about size limits and cautious use of maxInlineBase64Bytes. Missing explicit when-not-to-use compared to siblings.

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