search_index_index_list_docs

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

With no annotations, the description only mentions pagination but omits important behavioral traits like auth requirements, error handling, default limit, ordering, or whether it returns all documents. Too sparse.

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 very concise (single sentence) with front-loaded verb and resource, but it is too brief to be optimally useful. It could add a bit more detail without sacrificing conciseness.

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?

Despite having an output schema, the description does not clarify what the paginated list returns or explain the parameters. For a 3-param list tool with no schema descriptions, it is incomplete.

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 coverage is 0% and the description does not explain parameters name, limit, or offset. It only implies that 'name' is the index name via the [search_index] prefix, but no explicit semantics.

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 verb 'List', the resource 'documents in an index', and notes pagination. It distinguishes from sibling tools like 'search_index_index_list' (list indices) and 'search_index_index_search' (search documents).

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 versus alternatives like search_index_index_search or search_index_index_list. No exclusions or contextual hints provided.

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