Get TurboQuant index metadata

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

Annotations indicate read-only. Description adds behavioral details: it raises on missing conditions, preserves raw_metadata for unanticipated fields, and lists the returned typed attributes. No contradiction with annotations.

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: first states purpose, second adds behavioral context, third lists return fields. Front-loaded and efficient. Minor room for improvement in condensing the return field list, but overall concise.

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 the existence of an output schema and the tool's simplicity, the description covers purpose, error conditions, and return structure comprehensively. The mention of raw_metadata adds completeness for handling unanticipated fields.

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 low (33%); only the 'database' parameter has a description. The description mentions schema and index names in the context of the index identifier but does not provide additional semantics, formatting, or examples for the parameters beyond the schema types.

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 the verb 'fetch', the resource 'tq_index_metadata for a single turboquant index', and the scope 'by schema and index name'. Distinguishes from siblings like list_turboquant_indexes and get_turboquant_heap_stats by focusing on metadata retrieval for a single index.

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?

Provides context on when the tool raises errors (extension not installed or index not found). Implicitly guides use for metadata retrieval versus listing all indexes, but does not explicitly state alternatives or when not to use.

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