search_kb_docs

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description adds the POST endpoint and the semantic-search behavior, but says nothing about result scoring, pagination, or how vector vs query search is handled.

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?

Three sentences, front-loaded with purpose and routing. Every sentence earns its place and there is no repetition of schema or annotations.

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?

This is a complex nine-parameter search tool with no output schema and very low schema description coverage. The description gives good routing but leaves the agent without enough information to choose the right search mode or understand the non-obvious parameters.

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 11% (only max_chunks is documented), and the description adds no meaningful guidance for the other eight parameters. It implies semantic/vector input but does not explain when to use searchQuery instead of vector, what vectorDb or defaultDimension do, or how similarity_threshold affects results.

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?

States a specific verb and resource: semantic/vector search over an agent knowledge base, with the endpoint noted. It explicitly contrasts with list_kb_docs and CRUD siblings, so an agent can identify its role without opening the schema.

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?

Gives explicit when-to-use guidance: prefer this over list_kb_docs when looking for content by meaning. It also routes CRUD operations to create_kb_doc, get_kb_doc, and patch_kb_doc.

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