search_index

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

The description adds value beyond the schema by stating the search is read-only and bounded, and that scripts and runtime mappings are blocked. However, it lacks details on error handling, rate limits, pagination, or the meaning of 'bounded' in terms of result limits. With no annotations, the description carries the burden but only partially fulfills it.

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 a single sentence, which is concise, but it omits important information that would help the agent. Every sentence should earn its place; here the sentence is too brief to be fully informative.

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 tool's complexity (search with Query DSL, 6 parameters, output schema present), the description is insufficient. It does not explain how to formulate the query, the meaning of 'bounded', or the structure of the response. The output schema exists, but the description fails to provide the operational context needed for correct invocation.

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 input schema has 0% description coverage, so the description must explain parameter meanings. It does not mention any parameter, including the critical 'query' parameter which is a complex JSON object. The description fails to clarify what Query DSL is or how to construct the query, leaving the agent with only parameter names.

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 runs a bounded read-only Query DSL search, specifying the action and resource. This distinguishes it from sibling tools like get_latest_documents or list_indices, which serve different purposes.

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 vs. alternatives like get_latest_documents or get_field_count. The description only mentions that scripts and runtime mappings are blocked, but does not explain the appropriate context for using search_index.

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