jira_upload_attachment

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

The description lacks details beyond what annotations convey. It does not disclose potential impacts like file size limits, overwrite behavior, permission requirements, or whether the attachment is appended or replaces existing ones. Annotations indicate a write operation (readOnlyHint: false), but the description adds no extra behavioral context.

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 a single, clear sentence with no unnecessary words. It is appropriately concise but could be front-loaded with more critical information about usage context (e.g., required arguments).

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?

Given the tool's complexity (3 parameters, write operation with file), the description is insufficient. It omits relevant context such as output schema details, error handling, file format constraints, and interaction with issue state. The presence of an output schema partly compensates, but critical usage context is missing.

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% with each parameter already described (issue_key, file_path, filename). The description 'Upload a file as an attachment' adds no additional meaning beyond the schema. A baseline of 3 is appropriate since schema covers parameter semantics fully.

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 the action (upload) and the resource (file as attachment to a Jira issue). It distinguishes this tool from siblings like jira_download_attachment, jira_get_attachments, and jira_delete_attachment, which have different verbs.

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?

No guidance is provided on when to use this tool or when to consider alternatives. There is no mention of prerequisites (e.g., issue must exist) or comparison to related tools like jira_create_issue which may also handle attachments.

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