get_index

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

No annotations are provided, so the description carries the full burden. It mentions output storage and object IDs but lacks disclosure of side effects, authentication needs, rate limits, or error conditions. The tool is implied to be read-only but not explicitly stated.

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 moderately concise but includes repeated guidance on using the object ID (two sentences essentially redundant). It could be trimmed by merging the output handling instructions.

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 fetch tool with one parameter and no output schema, the description covers purpose, parameter, and output behavior. However, it does not mention error handling or what happens if the index doesn't exist.

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 description includes a docstring for index_name: 'Unique name of the index to fetch.', which adds a bit of meaning beyond the schema's 'Index Name' title. However, with 0% schema coverage, more detailed constraints or format guidance would be beneficial.

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 'Fetches detailed configuration information for a specific index', which is a specific verb+resource combination. It distinguishes itself from siblings like create_index, update_index, and list_indexes by focusing on a single index retrieval.

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 provides guidance on how to use the output (object ID and object store tools), but does not explicitly state when to use this tool versus alternatives like list_indexes or get_workspace, nor does it include any exclusion criteria.

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