upload_attachment

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

Provides behavioral constraints (scope, size, token usage) beyond annotations which only indicate non-read-only and non-destructive. Does not contradict annotations.

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?

Two sentences with no filler; first sentence provides action and return value, second adds scope and size. Highly efficient and 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?

Covers all critical aspects: action, return token, usage in ticket comment, scope, size limit. Output schema exists, so return values are further detailed. Lacks error handling details but adequate for this tool.

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?

With 0% schema description coverage, description adds meaning: 'base64' clarifies data_base64 encoding. File_name is obvious, content_type lacks detail but has default. Partial compensation for coverage gap.

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?

Description clearly states the verb (Upload), resource (file to Zendesk), and purpose (returns upload token for create_ticket_comment), distinguishing it from siblings like get_ticket_attachment which is read-only.

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?

Specifies required scope (tickets:write) and size limit (10 MB), and explains the token's use in create_ticket_comment, guiding when to use this tool. Could be more explicit about when not to use, but context is clear.

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