search_all_docs

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

No annotations are provided, so the description carries the full burden. It mentions the optional filtering behavior, but does not disclose other key traits such as whether this is a read-only operation, how results are returned (e.g., pagination, format), performance expectations, or error handling. The description is minimal and misses important behavioral context.

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 extremely concise with two sentences that directly state the tool's function and optional feature. It is front-loaded with the core purpose and wastes no words, making it efficient and easy to parse.

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 tool has no annotations and no output schema, the description is incomplete. It covers the basic purpose and optional filtering but lacks details on return values, error conditions, or behavioral nuances. For a search tool with multiple parameters and sibling alternatives, more context is needed to guide effective use.

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 schema already documents both parameters ('query' and 'doc_slugs') with clear descriptions. The description adds marginal value by emphasizing the optional nature of 'doc_slugs' and hinting at default behavior ('searches across top documentation sets'), but does not provide additional syntax or format details beyond the schema.

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's purpose: 'Search across multiple documentation sets' with the specific action 'search' and resource 'documentation sets'. It distinguishes from the sibling 'search_doc' by specifying 'multiple documentation sets' versus potentially a single documentation set, though the distinction could be more explicit.

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 implies usage by mentioning 'Optionally filter by specific documentation slugs', suggesting when to use this optional feature. However, it lacks explicit guidance on when to choose this tool over alternatives like 'search_doc' or 'list_docs', and does not specify prerequisites or exclusions.

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