search_docs

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

No annotations are provided, so description carries full burden. It describes the tool as searching documentation and returning formatted results, which is sufficient for a read-only search tool. However, it does not disclose potential limitations like maximum result count or source freshness.

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 concise with two paragraphs and a parameter docstring. It front-loads the main purpose and then elaborates. The docstring adds structure but could be shortened.

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 no output schema and one parameter, the description covers the basic purpose and usage. However, it lacks details about how results are formatted, pagination, or error handling, which would be helpful for an agent.

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?

The description includes a brief docstring for the query parameter, adding meaning beyond the input schema which has no description. However, schema coverage is 0%, so description partially compensates. It explains what the query is used for but does not detail expected format or examples.

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 deepset documentation for information about features, API usage, best practices, and troubleshooting guides. It distinguishes from sibling tools like search_pipeline or search_templates by specifying documentation domain.

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 mentions using it to look up specific functionality or help users, but does not explicitly state when not to use it or provide alternatives. It implies usage context but lacks exclusion guidance.

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