Get TurboQuant heap stats

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

Annotations already declare readOnlyHint=true, and the description is consistent. It adds behavioral detail beyond annotations: it preserves raw upstream payload in a 'raw' field and explicitly states the extension requirement. No contradictions 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?

Two concise sentences, front-loaded with the primary action. Every sentence adds value: the first states the purpose, the second adds raw payload and requirement details. No wasted words.

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 tool has an output schema (so return values aren't needed in description), the description covers purpose and raw payload. However, it lacks usage context compared to siblings and does not explain 'heap row count' further. Adequate but not fully comprehensive for a tool with 3 parameters and a read operation.

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?

Only 33% of parameters have descriptions in the schema (database). The description mentions 'single turboquant index (schema.index)' hinting at schema and index parameters but provides no additional semantic details like format, constraints, or examples. With low schema coverage, the description fails to compensate meaningfully.

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 returns 'exact heap row count' for a single turboquant index, using the specific function tq_index_heap_stats(). It distinguishes from siblings like get_turboquant_index_metadata or get_turboquant_last_scan_stats by focusing on heap row count and preserving raw upstream payload.

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 is provided on when to use this tool versus alternatives such as get_turboquant_index_metadata or list_turboquant_indexes. The only context is the requirement for the pg_turboquant extension, which is a prerequisite rather than usage direction.

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