get_index_details

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

Explicitly describes the operation as a read ('Read'), implying no destructive side effects. Although no annotations exist, the description sufficiently discloses the non-mutating nature and what is retrieved.

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?

Single sentence with no extraneous text. The verb is front-loaded, and the purpose is stated immediately.

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?

Output schema handles return values, but the tool has 4 required parameters with no documentation in schema or description. An agent cannot determine how to fill these parameters without additional 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?

Input schema has 0% coverage (no parameter descriptions). The tool description does not mention any parameters, their meaning, or expected format. This is a critical gap for an agent to invoke the tool correctly.

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 the tool's verb (Read) and resource (index or safe pattern), listing the types of data returned: settings, mappings, aliases, operational stats. This distinguishes it from sibling tools that focus on cluster health, disk allocation, etc.

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 on when to use this tool versus alternatives like get_cluster_settings or get_field_mapping. Absence of any context about prerequisites, valid conditions, or when not to use.

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