Search docsets

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

With no annotations, the description carries the full burden. It discloses the fuzzy matching behavior and the exact output shape ('compact rows: slug, type, name, path'), plus the path's role in follow-up tools. It does not cover edge cases like empty results or sorting, but for a read-only search these are minor gaps.

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, front-loaded with the core operation, followed by output details and a workflow hint. No filler; every clause contributes meaningfully.

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 tool is simple (3 params, no output schema, no annotations). The description covers purpose, return format, and how to use the result via read/toc. It omits edge cases like no-match behavior, but for a search tool it is largely complete and does most of the work in the absence of annotations.

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 67%: query and docsets have descriptions, while limit has only type/default/min/max. The description adds context by explaining the query is fuzzy and that docsets are installed slugs, but it does not elaborate on limit beyond schema constraints. This provides marginal extra value, so a 3 is appropriate.

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 states a specific verb and resource: 'Fuzzy search entry names across installed docsets.' It also lists the output fields and the follow-up workflow ('Feed a path to read/toc'), which clearly distinguishes it from siblings like list_docsets (lists docsets) and read/toc (consume paths).

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 clear context: search is the entry point for locating entries, and the line 'Feed a path to read/toc' tells the agent when to use read/toc after search. It does not explicitly mention alternatives or when not to use this tool, but the workflow hint gives practical selection guidance.

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