search

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

The description discloses that results are grouped by type and that a default session is used if not provided. However, it does not explicitly state read-only nature, permissions, or side effects. Annotations are absent, so the description carries the burden but misses some details.

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?

Two sentences efficiently convey the purpose and session behavior. No unnecessary words, and the most critical information is 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?

Given the presence of an output schema and moderate complexity, the description covers the essential aspects. However, it omits details on pagination, ordering, or result format, which could be relevant for search operations.

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?

With 0% schema description coverage, the description partially compensates by explaining the tool's scope and group behavior. However, it does not detail the meaning or constraints of the project_id or text parameters, leaving gaps in parameter understanding.

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 searches within a project for various items like user stories, tasks, issues, wiki pages, and returns grouped results. It effectively conveys the verb and resource, but does not explicitly differentiate from sibling list tools.

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 specific get_ or list_ tools. The description mentions session fallback but lacks when-to-use or when-not-to-use advice.

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