search_docs

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

With no annotations, the description must disclose behaviors but fails to mention pagination (cursor, limit), results format, authorization needs, or side effects. The version '(v3)' hints at changes but offers no detail. Agent cannot infer important constraints.

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?

At 7 words, the description is extremely concise but omits essential details like pagination and filtering. While front-loaded, it sacrifices completeness for brevity, which is a trade-off but not optimal.

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 7 parameters, no output schema, and no annotations, the description is severely incomplete. It neglects pagination, query syntax, filtering options, and response structure. Agents cannot use this tool reliably without external knowledge.

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 only 43% (3 of 7 params documented). The tool description adds no additional parameter info, leaving crucial parameters like parent_id, parent_type, limit, and include_archived unexplained. Agents lack context for correct usage.

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/lists Docs in a Workspace, which is a specific verb+resource. However, it does not explicitly differentiate from sibling tools like get_doc (singular retrieval) or get_doc_page_listing (pages within a doc), leaving some ambiguity in scope.

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 provided on when to use this tool versus alternatives like get_doc for a single doc or get_doc_page_listing for pages. There is no mention of prerequisites or typical scenarios.

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