knn_search

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

No annotations are provided, so the description carries full burden. It mentions parameters and an example but doesn't disclose behavioral traits such as performance characteristics, error handling, authentication needs, rate limits, or what the output looks like. For a vector search tool with no annotations, this is a significant gap.

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 well-structured with clear sections for parameters and an example, and it's appropriately sized without unnecessary text. However, the title is null and the purpose statement is brief, slightly reducing efficiency.

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 (6 parameters, nested objects, no output schema) and lack of annotations, the description is incomplete. It covers parameters but misses crucial context like output format, error conditions, and behavioral details needed for a vector search operation in what appears to be an Elasticsearch context.

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 lists all 6 parameters with brief explanations in Chinese (e.g., '索引名称' for index, '向量字段名' for field), adding meaning beyond the schema which has 0% description coverage. However, it doesn't provide details on formats (e.g., vector array structure) or constraints, so it doesn't fully compensate for the schema gap.

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 'K近邻向量搜索' (K-nearest neighbor vector search) which provides a general purpose, but it's vague about the specific resource and lacks differentiation from sibling tools like 'search' or 'search_simple'. It doesn't specify what type of data or system this operates on (e.g., Elasticsearch indices).

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 guidance is provided on when to use this tool versus alternatives like 'search' or 'search_simple'. The description only lists parameters and an example without context about appropriate use cases or prerequisites.

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