List Indexes

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

No annotations are provided, so the description carries the burden. It discloses that it excludes internal system indexes and that results are permission-constrained. This adds useful behavioral context beyond just 'list indexes'. It's not super detailed but sufficient for a listing tool.

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?

Three sentences, front-loaded with purpose, then specifics. No fluff, each sentence 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?

For a zero-parameter, zero-output-schema tool, the description provides key context: what it returns, what it excludes, and permission constraints. Missing explicit return structure but adequate given no schema.

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 tool has zero parameters, so there are no parameters to describe. The schema coverage is 100% (trivially). The description adds no parameter-specific info because there is none needed. Baseline for 0 params is 4.

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 'Retrieve all accessible data indexes' with a specific resource (data indexes) and scope (accessible). It distinguishes from sibling tools like run_splunk_search or list_saved_searches by focusing on index discovery for querying. The verb 'Retrieve' and resource 'data indexes' are specific and unambiguous.

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?

The description states when to use it ('when building searches or queries') and explains context (returns only customer indexes). It doesn't explicitly discuss when NOT to use it or name alternatives, but given the siblings are mostly search/configuration tools, the purpose is clear enough. It could explicitly say 'use this to find the right index before querying' but implied.

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