get_dimension_values

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

With no annotations, the description carries the burden and does disclose key behavioral traits: the 404 failure on most CBS datasets, and the fact that it does not resolve codes/labels (unlike get_dimensions). However, it omits other traits like pagination limits beyond the top parameter and does not explicitly state that it is a safe read operation.

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 well-organized: a one-sentence purpose, a prominent warning, a clear Args list, and a Returns line. Every section serves a purpose without unnecessary filler.

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 provides enough context for the tool's core function and major caveat (404 on most CBS datasets, prefer get_dimensions). The Returns line describes the output shape. It could be more complete by explaining why one would ever use this over get_dimensions, but given the output schema coverage and clear warning, it is adequate.

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 0%, so the description must compensate. The Args section lists parameters but adds little beyond the schema: 'select: OData `$select`' is tautological, and 'catalog: Catalog identifier' just restates the name. No examples, defaults, or allowed values are provided.

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?

Opening sentence 'Fetch values for a specific dimension' clearly states the action and target. Distinguishes from sibling get_dimensions by explicitly warning that this endpoint 404s on most CBS datasets and recommending get_dimensions instead.

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 provides when-to-use guidance via the warning and alternative: 'Prefer get_dimensions(), which already resolves all dimension codes and labels via the reliable {dim}Codes endpoints.' This clearly tells the agent when not to use this tool.

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