search_hpe_kb

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

With no annotations, the description carries the full burden and discloses important behavior: login is required, HPE gates search behind authentication, and search results expose docId values. It also names a likely error condition and a recovery path, which is valuable transparency beyond the schema.

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 front-loaded with the core purpose and then adds concise, high-value operational guidance. Every sentence earns its place; there is no filler or redundant restating of the schema.

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?

For a two-parameter search tool with no annotations and no output schema, the description covers the key context: authentication requirements, likely failure, result hint (docId), and the correct follow-up tool. It does not explain pagination or result formatting, but those are secondary given the simple interface.

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 tells the agent that query is a keyword, adding a little meaning beyond the bare schema property. However, with 0% schema description coverage, max_results is left entirely to the agent to infer from its name and default, so the compensation is only partial.

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 states a specific action ('Search') and a clear resource ('HPE Support Center knowledgebase by keyword'). It also references the sibling tool get_hpe_document as the follow-up reader, which helps disambiguate it from related tools.

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 gives clear context for when to use this tool and covers an explicit fallback: if authentication_required is returned, use a web search and then get_hpe_document. It does not explicitly contrast with list_hpe_document_topics, but the search-vs-read distinction is strongly implied.

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