document_search

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. It mentions content and metadata search and prerequisites, but does not disclose return format, pagination, permissions, or side effects. An output schema exists but is not shown; description could still add value here.

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 structured with a prerequisites section and a summary sentence. While the prerequisites are necessary, they are verbose. No redundant information, but the main description is brief.

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 complexity (nested parameters, output schema exists, sibling tools), the description covers purpose, prerequisites, and basic behavior. It lacks details on edge cases and output interpretation, but the input schema provides some of that. Annotations would further improve completeness.

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 specifies that search_term is for CBR content search and can be empty for metadata-only, adding meaning beyond the schema. It also clarifies that search_class and search_properties require prior tool calls. With 67% schema coverage, this adds useful context.

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 for documents based on content and metadata criteria, distinguishing it from sibling tools like lookup_documents_by_name and repository_object_search. The prerequisites section further clarifies the 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?

The description explicitly lists prerequisite steps (determine_class, get_searchable_property_descriptions) and notes that the search class must be a document class or subclass, providing clear usage guidance. However, it does not explain when to use this tool versus alternatives like repository_object_search.

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