autotask_get_ticket_attachment

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

With no annotations, the description fully discloses behavioral traits: default metadata-only, data retrieval via top-level endpoint, verification of attachment ownership, stripping of oversized binaries with a reason field, and size limits. This is excellent transparency.

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 informative and front-loaded, but slightly verbose. Every sentence adds value, but some internal details (e.g., child endpoint never populates data) could be omitted. Still efficient overall.

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?

The tool has 4 parameters and no output schema. The description covers behavior, size limits, and modes, but does not specify the exact fields returned in metadata. For a get tool, this is mostly complete but could mention metadata structure for browsing.

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% with parameter descriptions. The description adds meaning beyond the schema by explaining default behavior, the purpose of maxInlineBase64Bytes, and the data omission mechanism. It provides valuable context.

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 'Get a ticket attachment' and explains the two modes (metadata only vs data). However, it does not explicitly differentiate this tool from siblings like search_ticket_attachments or create_ticket_attachment, though the purpose is well-defined.

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 clear guidance on when to use includeData=false vs true, mentions suitability for browsing, and warns about size limits and MCP client constraints. It does not explicitly state when not to use this tool, but the context is sufficient.

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