List Indexes

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, indicating a safe read operation. The description adds useful context about default schema behavior and the specific fields returned, enhancing transparency beyond structured fields.

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 succinct, using a clear docstring format with Args and Returns sections. Every sentence adds value, and the purpose is front-loaded in the first sentence. No redundant or irrelevant information.

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?

For a simple read-only list tool, the description covers the input parameters, default behavior, and return structure comprehensively. Annotations confirm safety, and no output schema is needed since the return is self-explanatory. The tool is fully specified for agent use.

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% and the description repeats the same parameter descriptions verbatim, adding no new meaning beyond what the input schema provides. Baseline score of 3 is appropriate since the schema already documents both parameters adequately.

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?

Clearly states 'List all indexes on a table including columns, uniqueness, and index type,' specifying the exact resource and returned attributes. Differentiates from siblings like kb_list_constraints and kb_describe_table 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?

Describes what the tool does but does not provide explicit guidance on when to use it versus alternatives such as kb_list_constraints or kb_describe_table. The description is adequate but lacks exclusion criteria or context for selection among ten sibling tools.

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