jira_search_issues

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

No annotations are provided, leaving the full burden on the description. The description only states it 'searches' but does not disclose return format, pagination behavior, error handling (e.g., invalid JQL), or whether it's read-only (implied but not explicit). Minimal behavioral insight beyond the basic action.

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 sentence with examples, no fluff. Purpose is front-loaded and every word earns its place. Examples are embedded efficiently without additional commentary.

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 parameter schema covers the inputs and there is no output schema, the description adequately explains what the tool does but does not describe the output format, result structure, or how results relate to siblings. It is minimally complete for a straightforward search tool but lacks contextual details about pagination and default behavior (though maxResults default is in schema).

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%, so baseline is 3. The description adds value by providing concrete JQL examples that demonstrate how to construct queries, going beyond the schema's generic 'JQL query string' description. This helps an agent understand parameter usage effectively.

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?

Clearly states the tool searches for Jira issues using JQL, with specific examples that immediately convey the purpose. Distinguishes from siblings like jira_get_issue (single issue) through the use of search and JQL.

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?

Provides examples of JQL queries, which gives implicit context on how to use the tool. However, no explicit guidance on when to use this over alternatives like jira_get_issue or jira_get_projects, nor any prerequisites or limitations.

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