jira_search

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

With no annotations, the description carries full burden. It discloses that results are in YAML, the default limit is 20, and passing 0 gives unlimited results. It also explains that convenience filters are ANDed. However, it does not detail the structure of the returned YAML or any side effects, which is a minor gap.

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, front-loaded with the main purpose, no redundant information. Every sentence adds value, and the structure is clear.

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 tool has 6 parameters and no output schema, the description covers input behavior well. It mentions the output format (YAML) and references sibling tools. However, it could be slightly improved by specifying the structure of the YAML response or handling of pagination, but it is sufficient for a search tool.

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 significant value beyond schema: explains the AND logic of convenience filters, the override behavior when jql is provided, the default limit, and the date format. It also provides an example JQL query.

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 verb 'Search', resource 'JIRA issues', and method 'using a JQL query'. It also distinguishes itself from sibling tools by naming jira_board_issues and jira_sprint_issues as alternatives for listing issues on a board or sprint.

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?

Explicitly explains when to use the tool (searching issues via JQL or convenience filters) and when not to (listing issues on a board or sprint), providing alternative tool names. Also states that at least one filter is required.

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