oci_search_documentation

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

No annotations are provided, so the description must cover behavioral traits. It implies a read-only search operation but does not explicitly state it is non-destructive, nor does it mention rate limits, authentication, or the exact return format (e.g., whether it returns snippets or just URLs). The search tips offer some guidance but not full transparency.

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 three sections: a one-line summary, usage paragraph, and search tips. It is front-loaded and each section adds value without redundancy.

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 existence of an output schema and a sibling tool, the description is fairly complete. It explains when to use the tool, how to formulate queries, and implies pagination via parameters. However, it does not explicitly describe pagination behavior or result sorting.

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 baseline is 3. The description does not add additional meaning beyond the schema for the parameters; it only provides general search tips that apply to the search_phrase parameter. Page and limit are not elaborated further.

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 OCI documentation based on a search phrase, and explicitly distinguishes it from the sibling tool oci_read_documentation by noting it is used when you don't have a specific URL.

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 includes explicit guidance on when to use this tool versus the sibling, stating 'Use it to find relevant documentation urls about OCI Products when you don't have a specific URL.' It also provides search tips for effective usage.

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