jira_search

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

With no annotations provided, the description carries the burden of disclosing behavior. It states it returns a compact list and enumerates the fields, which clarifies the output format. The verb 'search' implies a read-only operation, though it does not explicitly declare the absence of side effects or any authentication 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, and front-loaded with the action and expected output. Every clause adds information.

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 read-only search tool, the description covers the core purpose, the return payload, and (via schema) parameter constraints, which is sufficient given the tool's simplicity. No output schema exists, but the description compensates by naming the exact fields returned.

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?

All three parameters have schema descriptions, giving a baseline of 3. The description adds value by specifying the default field set ('key, summary, status, assignee, priority, updated'), which directly clarifies what the 'fields' parameter means by 'beyond the default summary set'. This counts as extra semantic detail beyond the schema.

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 opens with 'Search Jira issues with a JQL query', which names a specific action (search) and resource (Jira issues) using the JQL query language. It also specifies the return scope ('compact list' with exact fields), distinguishing it from jira_get_issue (single issue retrieval).

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?

It clearly states the tool is for searching Jira issues via JQL, implying use for broad queries rather than single-issue retrieval (which is covered by sibling jira_get_issue). However, it does not explicitly mention alternative tools or exclusion cases, so it earns 4 rather than 5.

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