jira_search

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

With no annotations, the description carries the full burden. It implies read-only behavior ('Discover') and explains what each resource returns. It discloses defaults (maxResults, includeIssues) but does not explicitly mention auth needs or lack of side effects. Still, the description is reasonably transparent.

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 long but well-structured with bullet points and clear resource groupings. Every sentence adds value. Minor excess whitespace but overall concise for the 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?

Given 13 parameters and no output schema, the description is highly complete. It covers all resource types, parameter relevance, and usage flow (e.g., boards then sprints). Users or agents will have a clear mental model of what the tool does and how to use it.

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 by explaining which parameters apply to which resources, the order of operations (e.g., use boards first to get boardId), and contextual hints like 'mine=true for your queue'. This exceeds baseline.

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 tool discovers Jira resources and lists eight specific resource types with distinct purposes. It distinguishes itself from sibling tools like jira_get (single issue) and jira_version (version management).

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 explicit when-to-use guidance for each resource, including prerequisites (e.g., need boardId before sprints/board_overview, use boards to find it) and when to create a version instead of asking the user. It sets defaults and covers common queries like mine=true.

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