jira_search

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

The description indicates it is a search (read) operation, but no annotations exist. It does not disclose rate limits, authentication requirements, or any side effects. For a read-only tool, the lack of such details is acceptable but not exemplary.

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 that efficiently conveys the tool's purpose and output format. No extraneous information is included, making it highly concise and front-loaded.

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 description is mostly complete for a simple search tool, given the detailed schema. However, it could mention that standard fields are always returned and that the 'fields' parameter is optional. Without an output schema, the agent might benefit from more context on returned data structure.

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 input schema has 100% coverage, with each parameter described. The description adds no additional meaning beyond stating the use of a JQL query. Thus, the description does not improve on the schema's own parameter explanations.

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 the action ('Search'), the resource ('JIRA issues'), and the method ('using a JQL query'). It also specifies the output format ('YAML'). This distinguishes it from other tools that search by board or sprint, though more explicit differentiation could be added.

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?

No guidance is provided on when to use this tool versus alternatives like jira_read, jira_board_issues, or jira_sprint_issues. The description does not mention context, prerequisites, or exclusions.

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