index_bloat

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

No annotations are present, so the description must carry all behavioral transparency. It labels the operation as '[READ]' and 'coarse estimate', but fails to disclose potential performance impact, required permissions, or what exactly 'coarse' means in terms of accuracy or methodology.

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 highly concise with two sentences plus a bullet list for parameters. The purpose is front-loaded with '[READ]' and no extraneous information. Every line adds value.

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 no output schema and a simple tool, the description omits crucial details about what the tool returns (e.g., a list of indexes with bloat percentages). It only mentions 'all inputs returned for transparency', which is insufficient. There is also no indication of whether this tool requires special permissions or has performance implications.

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 provides no descriptions for parameters (0% coverage), but the description's 'Args' section adds meaning: 'limit' is explained as number of indexes inspected (largest first, default 50) and 'target' as target name from config. This sufficiently clarifies parameter usage.

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 estimates index bloat, with the '[READ]' tag and explicit mention of 'index-bloat estimate'. The name matches the purpose, and it distinguishes from sibling tools like 'table_bloat' and 'bloat_and_vacuum_analysis' by focusing on indexes.

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 such as 'bloat_and_vacuum_analysis' or 'table_bloat'. There is no discussion of prerequisites, context, or cases where this tool is preferred or not.

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