get_shard_allocation

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

No annotations are provided, so description carries full burden. It states what is listed, but omits behavioral traits like read-only nature, permission requirements, or performance impact. Decent but could explicitly state it's a read-only snapshot.

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, front-loaded with verb 'List', no extraneous words. Perfectly concise for the information it conveys.

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?

Tool has 4 parameters with no descriptions and sibling relationships unexplained. Despite output schema existing, the lack of parameter context and usage guidance makes it incomplete for an agent to use effectively.

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 0% and description adds no parameter explanations. The four parameters (domain, region, profile, index_pattern) are undocumented beyond their names and types, forcing agent to guess their roles.

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 uses specific verb 'List' and clearly identifies the resource 'primary and replica shard states, nodes, sizes and unassigned reasons'. It effectively distinguishes from sibling tools like explain_unassigned_shard (which focuses on explanations) and get_disk_allocation (disk-level).

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 vs alternatives such as explain_unassigned_shard or get_cluster_health. Missing context about prerequisites or typical use cases, leaving agent to infer usage.

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