jira_version_list

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

No annotations are provided, so the description carries the burden. It adds transparency by stating the output is YAML and that filtering is optional. However, it does not disclose whether the operation is read-only, if pagination exists, or any permission requirements.

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?

Two sentences, no filler. Key information is front-loaded: action, resource, optional filters, output format. Every word earns its place.

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 is a simple list operation with no nested objects or output schema, the description covers the main points: action, filters, output format. It could mention the list's content (versions) explicitly, but it's implied by the verb. No output schema means the YAML note is helpful. Slight lack of detail on return structure, but adequate for the tool's simplicity.

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% (all parameters have descriptions). The description repeats the filter names and their optionality, adding little beyond the schema. No extra semantic detail is provided.

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 lists versions for a JIRA project, with optional `released` and `archived` filters. It specifies output format (YAML) and mentions it mirrors a CLI command. This distinguishes it from siblings like `jira_version_create` and `jira_project_list`.

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 implies usage by naming the action and filters, but lacks explicit guidance on when to use this tool versus alternatives such as `jira_search` or `jira_read`. There is no mention of prerequisites or context for its use.

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