snb_get_cube_metadata

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

Annotations already declare read-only, non-destructive, idempotent behavior. The description adds context that it retrieves metadata for subsequent data queries, but does not provide additional behavioral details like rate limits or error cases. This is adequate given annotation coverage.

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 concise and well-structured: a one-line summary, a usage explanation, an Args section with parameter details, and a Returns section. Every sentence adds value without redundancy.

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 covers input, output, usage order, and annotations provide safety information. However, it does not detail the output format or error conditions, which would be useful for a complete understanding. Overall, it is sufficient for the tool's simplicity.

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 descriptions are sparse (0% coverage per context), but the tool description fully compensates by explaining both parameters with examples and purpose: cube_id (e.g., 'devkum', 'snbbipo') and lang (de/en/fr with effect on labels). This adds significant meaning beyond the schema.

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 that the tool retrieves metadata and dimension structure for SNB data cubes, using specific verbs and resources. It distinguishes itself from sibling tools, notably snb_get_cube_data, by stating this tool is for metadata and should be used 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 advises to use this tool before querying snb_get_cube_data to understand available parameters and filters, providing clear when-to-use guidance and differentiating from data retrieval tools.

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