devops_wiki_search

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

With no annotations, the description must disclose behavior. It mentions snippet context and filtering but omits pagination behavior (top/skip), rate limits, or authentication needs. The schema provides parameter descriptions, but the description adds little beyond summarizing.

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 with no fluff. The description is front-loaded with the core action ('Search wiki pages') and includes one additional detail about filtering. Every word earns its place.

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 (implied by 'Returns matching pages with snippet context'), the description does not need to detail return fields. However, it could mention pagination behavior (e.g., results are pageable via top/skip parameters) to avoid ambiguity. Overall, it is mostly complete 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 description coverage is 100%, so the baseline is 3. The description restates the filter and snippet context but does not add meaningful detail beyond what the schema already provides for each parameter.

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 wiki pages and returns results with snippet context. It differentiates from sibling tools like devops_code_search (code search), devops_work_item_search, and devops_wiki_page_get (single page retrieval).

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 explicit when-to-use or when-not-to-use guidance is given. The description mentions optional filtering by wiki name, which implies some context but does not direct the agent to alternatives when searching outside wiki pages.

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