IndexMappingTool

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

With no annotations, the description must convey behavioral traits. It states 'Retrieves,' implying a read-only operation, but does not disclose error handling (e.g., if index does not exist), authentication requirements beyond the schema, rate limits, or potential performance impact. This is insufficient for an agent to understand side effects.

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, efficient sentence of 12 words. It includes the verb, resource, and context with no extraneous information. Every word earns its place.

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 11 parameters (mostly connection-related) and no output schema, the description is incomplete. It does not describe what the returned mapping/setting information looks like or that it includes both mapping and settings. The agent lacks detail on expected return structure, which is critical for using the output.

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 100%, so the baseline is 3. The description does not add meaning beyond what the schema already provides for the 11 parameters. It does not clarify how connection parameters map to different auth methods or that 'index' is required. No additional value over schema.

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 identifies the tool's purpose: retrieving index mapping and setting information for an OpenSearch index. The verb 'Retrieves' specifies the operation, and the resource 'index mapping and setting information' is precise. This distinguishes it from sibling tools like ClusterHealthTool (cluster-level) or SearchIndexTool (search queries).

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 is provided on when to use this tool versus alternatives. While the purpose implies it is for inspecting index configuration, there is no mention of prerequisites (e.g., the index must exist) or common usage patterns. The description does not advise against use in write-heavy contexts.

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