idescat_get_table_metadata

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

No annotations provided, so description carries full burden. It discloses that the tool returns metadata (read operation) and highlights important ID differences. While it doesn't mention permissions or side effects, the behavioral context is solid for a read-oriented 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 with no wasted words. Front-loaded with purpose and an important usage note. Highly efficient.

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?

The description explains what the tool returns (dimensions, values, sources, link) and its sequential role. However, with 7 parameters and no output schema, the agent lacks full context on how to invoke the tool correctly (e.g., which parameters are required, how to use filters, response format). Could be more complete.

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 57% (low), but the description only minimally adds parameter meaning (e.g., table ID vs node ID). Major parameters like 'node', 'table', and 'statistics' lack explanation, and the 'filters' object is only noted in schema schema. The description does not sufficiently compensate for uncovered parameters.

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?

Description clearly states verb and resource: returns metadata of a table including dimensions, possible values, sources, and link. It distinguishes from sibling tools by emphasizing the difference between table ID and node ID, and its role before querying data.

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 use this tool BEFORE idescat_query_data to determine filters, and directs to first use idescat_list_catalog to obtain the correct table ID. Provides clear context and a conditional workflow.

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