bfs_get_table_metadata

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true. Description adds behavioral context: returns dimension variables with codes and value labels needed for queries. Shows example output structure, aiding understanding of return content.

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?

Well-structured with summary, usage context, args, returns, and example. Slightly verbose but front-loaded with purpose. Each section earns its place.

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 tool complexity and presence of output schema, description covers purpose, parameters, return structure, and next steps. Example output clarifies what to expect. No gaps identified.

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?

Description briefly mentions params (table_id, lang) but schema already provides detailed descriptions (patterns, defaults, enum). No additional semantics added beyond schema; baseline 3 is appropriate.

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?

Clearly states 'Get metadata for a BFS table' and specifies what metadata (title, variables, filter values). Explicitly distinguishes from sibling bfs_get_data by stating it's an essential step before data retrieval.

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 says 'Essential step before calling bfs_get_data', implying when to use. Provides context on what to do after (use variable codes in filters). No explicit when-not-to-use or alternatives mentioned.

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