jira_search_issues

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

Annotations already indicate read-only (readOnlyHint=true). Description adds behavioral details: supports complex queries, pagination with nextPageToken, and field selection. Does not mention rate limits or timeouts, but the added pagination guidance is valuable.

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?

Three sentences with no wasted words: purpose, examples, and pagination guidance. Front-loaded and efficient.

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 5 parameters and no output schema, description covers the essential usage: query, pagination, field selection. Could mention default maxResults, but schema already defines that. Lacks return value details, but output schema not present.

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 has full description coverage for all 5 parameters. Description complements with JQL examples, explains pagination token usage, and hints at field selection and expand. Adds meaningful context beyond schema definitions.

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 it searches Jira issues using JQL, with concrete examples. Differentiated from sibling tools like jira_get_issue (single issue retrieval) and jira_get_my_issues (personal issues).

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?

Explains usage with JQL, pagination via nextPageToken, and field selection. Provides examples. Does not explicitly state when not to use or compare to alternatives, but context is sufficient for an experienced user.

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