search_docs

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

The description discloses that it returns 'top matching sections with their hierarchical titles and full content,' indicating a read-only operation. However, it lacks details on rate limits, authorization, or constraints like maximum top_k value.

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 purpose, no unnecessary words. Every sentence adds value.

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 annotations and low schema coverage, the description is somewhat adequate but misses details on parameter semantics and lacks full behavioral disclosure (e.g., pagination, error handling).

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 schema has 0% coverage, yet the description does not explain the 'top_k' parameter (integer, default 5) and only implicitly covers 'query.' This leaves agents without guidance on how to use the optional parameter effectively.

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 function: 'Search the GenLayer documentation for relevant sections matching a query.' It distinguishes from siblings like get_section and list_sections by focusing on searching based on a query.

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 for finding documentation sections, but does not explicitly state when not to use it or provide alternatives. Sibling tools are listed but not referenced in guidance.

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