query_knowledge_hub

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

Discloses hybrid search (semantic + keyword) and that results include source citations. However, with no annotations, it omits details on idempotency, rate limits, or whether the search is stateful. Adequate but not comprehensive.

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?

Description is concise with four sentences, front-loading the core purpose. It lists parameters but could be better structured (e.g., using a list format). Still, it avoids unnecessary fluff.

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 search tool with 4 parameters and no output schema, the description covers the search mechanism and most parameters. However, the missing 'session_id' parameter explanation and lack of output format details leave gaps. Annotations would help, but none are provided.

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?

Input schema has 100% coverage and descriptions, but the tool's own description omits the 'session_id' parameter entirely and provides only marginal rephrasing of schema descriptions for other parameters. It adds value by explaining hybrid search but fails to cover all parameters.

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?

Description clearly states 'Search the knowledge base' with a specific verb and resource. It is distinct from sibling tools like delete_document and list_collections, establishing its purpose as a query/retrieval tool.

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 explicit guidance on when to use this tool versus siblings or alternatives. It does not mention conditions like 'use for document retrieval' or 'do not use for metadata-only queries.'

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