jira_get_issue

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

With no annotations, the description must convey behavior. It adds useful context about the response including 'description and recent comments', but it does not explicitly state that this is a read-only operation or describe error handling. The 'Fetch' verb implies safety, but more disclosure would be better.

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, compact sentence that leads with the action and resource. Every word earns its place with no fluff.

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?

For a simple read tool with two well-documented parameters and no output schema, the description gives enough context to understand the tool's purpose and output highlights. It does not describe all return fields, but that is acceptable given its simplicity. A more explicit statement about the full response shape would warrant a 5.

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% for both parameters (key and includeComments), so the baseline is 3. The description adds no extra meaning beyond the schema; it only mentions 'description and recent comments' which relates to the response, not parameter details.

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 ('Fetch'), the resource ('a single Jira issue'), and the key mechanism ('by key'). It also differentiates from siblings like jira_search by indicating it retrieves one specific issue rather than searching.

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 phrase 'by key' clearly indicates when to use this tool (when you have a known issue key), and the context is clear. However, it does not explicitly mention when to use alternatives like jira_search or exclude cases where the key might be unknown.

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