jira_add_attachment

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

The description details mutation behavior (upload) consistent with readOnlyHint=false and warns about high token costs. However, it fails to disclose that the input schema is empty, creating a mismatch between described parameters and actual schema. This undermines 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 structured with clear sections (EFFICIENT and DIRECT methods) and front-loads the main purpose. It provides examples and token cost information without excessive verbosity. Minor redundancy in the example could be trimmed.

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 explains return metadata (ID, download URL) despite no output schema. However, it omits how to specify the target Jira issue (e.g., issue key parameter), which is critical for invocation. This gap makes the tool definition incomplete.

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% (no parameters defined), but the description introduces parameters (fileUrl, content) that are absent from the schema. While the description adds value (token costs, methods), the inconsistency with the input schema confuses parameter semantics.

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 'Uploads an attachment to a Jira issue,' specifying a verb and resource. It distinguishes from sibling tools like jira_get_attachments and jira_delete_attachment. However, the empty input schema contradicts the described parameters, slightly reducing clarity.

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 guidance on when to use each method (EFFICIENT vs DIRECT) based on file size and token cost. However, it does not state when not to use this tool or mention alternatives. No exclusion criteria are given.

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