jira_search

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

With no annotations, the description must disclose behavior, but it omits details about result format, pagination, error behavior, or side effects. The example demonstrates a query but does not guarantee sorting or limit behavior. The read-only nature is implied but not stated.

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 sentence with a practical example. It is front-loaded with the core purpose and contains no fluff, earning a top score for conciseness.

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 no output schema or annotations, so the description bears full responsibility for explaining behavior. It fails to mention the return shape (list of issues, fields included), pagination, or limits beyond the schema's maxResults. The lack of distinction from jira_my_open_issues further reduces completeness.

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?

The schema already defines both parameters with descriptions, achieving 100% coverage. The description adds value for the 'jql' parameter by providing a concrete JQL example, demonstrating syntax, operators, and ordering — something the schema's 'JQL string' description lacks. The maxResults parameter is adequately covered by 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 clearly states 'Search Jira issues with JQL', giving a specific verb-resource-method combination. The example further clarifies the tool's scope, distinguishing it from sibling tools like jira_get_issue (which retrieves a single issue) by indicating broad JQL-based 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 description does not explicitly state when to use this tool over alternatives. The JQL example implies arbitrary search use cases, but there is no mention of 'use for complex queries' or 'instead of jira_my_open_issues for pre-filtered views'. This leaves the agent to infer usage context.

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