upload_attachment

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

No annotations are provided, so the description carries the full burden. It discloses the non-obvious two-step token workflow, the token expiry behavior, and the encoding contract for content. It omits auth requirements and size/type limits, but the token lifecycle disclosure is exactly the kind of behavior an agent cannot infer.

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?

Three short lines, front-loaded with the action and result, then downstream usage, then encoding rules. No filler sentences; every clause carries distinct information.

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?

An output schema exists, so return-value details need not be repeated, and the description already flags that the return is a token. Combined with the downstream-consumer mapping and expiry note, this is sufficient for correct invocation, with only secondary gaps (auth, limits, param exclusivity).

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 0%, so the description must compensate, and it does: it tells the agent to use content_text for text and content_base64 for binary, which is real semantic guidance beyond the bare schema titles. It does not clarify mutual exclusivity or what happens if both/neither are supplied, and filename gets no explanation.

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 verb and resource (upload a file to Redmine) and an unusual outcome (obtain a token), then names the exact sibling tools that consume that token. An agent can distinguish this two-step upload flow from add_project_file or create_issue without opening any schema.

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 says the resulting token is consumed by create_issue/update_issue uploads or add_project_file, and warns that unused tokens expire after a period. It gives clear context for when this tool is a prerequisite, but does not state when to prefer this over add_project_file (which appears to be a one-step alternative) or any preconditions.

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