jira_version

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

No annotations provided, so description carries full burden. It discloses key behaviors like default action, required parameters per action, and default values for release. Lacks details on potential errors or side effects (e.g., deleting an unused version), but otherwise sufficient.

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?

Single well-structured paragraph of 5 sentences, front-loaded with purpose and parameter guidance. No unnecessary words, every sentence adds 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?

Given 10 parameters and no output schema, the description fully explains the workflow for all actions, including integration with sibling tools (jira_search, jira_mutate). It is complete enough for an agent to use without confusion.

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%, but the description adds significant value: explains action defaults, which parameters are required for which actions, and default values for releaseDate and released. This goes beyond schema descriptions.

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 tool manages Jira fix versions (releases) and provides specific usage examples like 'create version 9.1.0' or 'release version X'. It distinguishes from sibling tools by mentioning version lookup via jira_search and setting via jira_mutate.

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?

Explicit guidance is given: action defaults to 'create', for create pass projectKey+name, for update/release/archive/delete pass id (looked up via jira_search). It also explains that 'release' sets released=true and defaults releaseDate to today.

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