jira_attachment_upload

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

Discloses streaming behavior and return format, but fails to mention authentication needs, size limits, or error handling. With no annotations, description carries burden but incomplete.

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 concise sentences front-loaded with purpose; no redundant information. Every sentence adds unique value.

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 inputs and output format, but misses prerequisites (auth, issue existence), constraints (max size, allowed types), and error scenarios. Adequate but not fully complete.

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?

Adds value beyond schema by explaining streaming and multipart request behavior. Schema already covers parameters, so description enhances meaning.

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?

Clearly states the action (upload), resource (attachments to JIRA issue), and provides specific detail (local files). Distinguishes from siblings like jira_attachment_delete.

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?

Indicates when to use (uploading attachments) but lacks explicit when-not-to-use or comparison with alternatives like jira_attachment_images.

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