tickets_upload_attachment

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

There are no annotations, so the description carries the behavioral burden. It does disclose the WRITE nature and the size constraint, but it does not describe what happens on success, whether the upload is synchronous, permission requirements, or overwrite behavior. The output schema exists but its contents are not shown, so return-value behavior remains unspecified.

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 concise sentences that front-load the core purpose and immediately state the key constraint. Every sentence earns its place, and there is no redundant restating of schema details.

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 description captures the essential calling constraint (inline path, <=5MB) and the schema covers all parameter semantics. It is reasonably complete for a simple one-shot upload tool, though it leaves some behavioral details like failure modes and response shape unspecified.

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 description coverage is 100%, so the schema already explains ticket_id, file_name, content_base64, and username. The description adds the 5MB inline-path limit, which is useful context, but it adds no additional meaning to individual parameters beyond what the schema provides.

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?

States a specific action ('Attach a file to a case') and marks it as a WRITE operation. This clearly distinguishes it from sibling tools like tickets_list_attachments, tickets_get_attachment_link, and tickets_delete_attachment. The scope is unambiguous enough for an agent to know what this tool does.

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 describes the supported inline path and the 5MB size boundary, and tells the agent that larger files require a different presigned-upload flow outside MCP. It does not name a sibling MCP alternative, but since the alternative requires a real filesystem, the exclusion is still practical and clear.

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