idescat_query_data

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

No annotations provided, so description must disclose behavioral traits. It only mentions the output format (array of flattened rows) and a usage warning, but omits auth requirements, rate limits, error handling, or whether operation is read-only. Significant gaps for a data retrieval 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?

Two sentences cover purpose, warning, and prerequisite steps. Efficient and front-loaded with no redundant content. Every 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?

With 8 parameters, no output schema, and no annotations, the description provides essential but incomplete context. It explains the output format and prerequisite steps, but does not cover parameter semantics for half the parameters, alternative parameter combinations (table_id vs separate fields), or data volume implications. Adequate but with clear gaps.

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 50% (4 of 8 parameters have descriptions). The description does not add meaning to undocumented parameters (geo, node, table, statistics) beyond the schema. It reiterates that filters are dimensions, but that is already in schema. Does not compensate for low coverage.

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 retrieves data from a table as flattened rows with labels. It distinguishes the table ID from node ID and references sibling tools for prerequisites, though it does not explicitly contrast with each sibling.

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?

Explicitly instructs to first use idescat_get_table_metadata to discover dimensions and filters, and to obtain table ID via idescat_list_catalog. Warns that table ID differs from node ID, providing clear when-to-use and prerequisite guidance.

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