get_issue

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: it discloses that fields replaces defaults entirely (not merges), that fields=[] returns only the key, and that certain data (comments, attachments, changelog) is deliberately excluded. This is meaningful behavioral disclosure that helps the agent predict the tool's behavior. A small gap is that it doesn't mention pagination or error behavior, but the annotations plus the explicit exclusions are strong.

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 compact and front-loaded: the core action ('Fetch one issue by key') comes first, followed by the most important parameter behavior, then the exclusions. Every sentence earns its place, and the exclusions are grouped efficiently. No fluff or repetition of schema details.

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?

The tool has an output schema, so return values are already documented structurally. The description covers the key behavioral aspects an agent needs: what the default fields are, how to override them, and what is not included. It also names sibling tools for the excluded data. The only slight gap is that it doesn't mention whether the response includes any metadata (e.g., expand) or how errors are surfaced, but given the output schema and annotations, the description is largely complete for correct invocation.

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 0%, so the description must compensate. It does: it explains the fields parameter's semantics in detail (replaces defaults entirely, default list, fields=[] behavior) and names the required issue_key parameter. The only minor gap is that it doesn't explicitly restate that issue_key is the Jira issue key format (e.g., PROJECT-123), but the parameter name and tool name make that obvious. Given the 0% schema coverage, the description carries the burden well.

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 states a specific verb ('Fetch') and resource ('one issue by key'), and immediately distinguishes itself from sibling tools by explicitly listing what it does not include (comments, attachments, changelog history) and pointing to dedicated tools for those. This makes the tool's purpose unmistakable and differentiates it from get_comments, get_attachments, and get_changelog.

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 provides explicit guidance on when to use this tool versus alternatives: it says to use dedicated tools for comments, attachments, and changelog history. It also explains the fields parameter behavior, including the default field set and the fields=[] special case, which tells the agent exactly how to control the response. This is clear, actionable usage guidance.

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