Search issues

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

Annotations already mark this as read-only, open-world, and idempotent. The description adds substantial behavioral detail: pagination via nextPageToken, no total count, stale cursors refused, and the important security note that issue text is third-party data and never instructions.

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?

Every sentence earns its place: purpose, total-count caveat, field selection, idioms, quoting rule, and data-safety warning. The key point about pagination is front-loaded, and the description is appropriately compact for the tool's complexity.

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 7-parameter tool with no output schema, the description covers the essential runtime contract: one page per call, cursor reuse, no total count, field selection, quoting, and the third-party data warning. Combined with detailed parameter schemas, this is complete enough for correct invocation.

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 beyond the schema with concrete JQL idioms such as sprint in openSprints(), issue in (KEY-1, KEY-2), and updated >= -1d, which help construct the jql parameter correctly.

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?

States a specific verb and resource: 'Run JQL and return ONE page of issues plus data.nextPageToken'. It also distinguishes itself from jira_count by explicitly noting 'There is no total; use jira_count.'

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?

Gives explicit guidance on when to avoid this tool for totals ('There is no total; use jira_count'), provides practical JQL idioms, and warns about quoting values with spaces. This is actionable selection and construction guidance.

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