search_documentation

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

With no annotations provided, the description carries the burden of behavioral disclosure. It does add one useful behavioral fact: 'Results are automatically truncated if they would exceed 25,000 tokens.' However, it omits other relevant behavior such as whether the search is read-only, whether FTS must be enabled first, or what the result structure looks like.

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 two sentences with no filler. The core purpose is front-loaded, and the truncation warning is a concise, valuable behavioral detail that 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?

The schema covers all parameters, and the truncation behavior is mentioned, which helps invocation. However, there is no output schema and no mention of the expected result shape, the relationship to FTS-enabled docsets, or when to prefer sibling tools, leaving moderate gaps for a tool with no 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 description coverage is 100%, so the baseline is 3. The description mentions 'docset identifiers and snippets' but does not add meaningful semantics beyond what the schema already provides for query, max_results, search_snippets, or docset_identifiers.

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 opens with a clear verb and object: 'Search for documentation across docset identifiers and snippets.' It is distinct from siblings like list_installed_docsets and load_documentation_page because it clearly names the search action, though it does not explicitly contrast itself with those alternatives.

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 given on when to use this tool versus load_documentation_page or enable_docset_fts. The description neither states the appropriate context for searching documentation nor excludes alternative tools, leaving the agent to infer when this tool is the right choice.

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