Search Jira issues

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

Annotations already declare readOnly, idempotent, and non-destructive behavior. The description adds beyond annotations by stating it returns Jira's raw response and may truncate large output—useful behavioral context. It could mention pagination behavior, but the nextPageToken parameter hints at that.

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 three sentences, each earning its place: the endpoint, the read-only uniqueness, and the response behavior. It is front-loaded with the main action and remains compact without fluff.

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 schema covers 75% of params, annotations cover safety, and no output schema exists, the description provides the essential context: endpoint, POST method, raw return, and truncation. It stops short of explaining pagination flow or error behavior, but the nextPageToken param implies pagination. Overall, a solid contextual package.

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 high (75% of params described), so the description need not repeat param details. The description adds no extra parameter semantics beyond the schema, but the schema already explains jql, fields, and nextPageToken. maxResults has constraints but no description; the description does not compensate for that gap. Baseline 3 applies.

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 starts with a specific verb and resource: 'Search Jira issues' and references the exact endpoint. It distinguishes from the sibling 'atlassian_get' by noting this is a POST operation, clarifying its unique role.

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 a clear context signal: 'This is the only read-only POST exposed by the server,' which implies its usage when a read-only POST is needed. It does not explicitly compare against atlassian_get, but the unique read-only POST framing offers practical guidance. No explicit exclusions are stated.

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