boj_get_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 large databases may overwhelm responses and recommends using a small limit or layer-based queries. This addresses a key behavioral trait (response size), though it does not mention error handling or authentication.

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 redundancy. First sentence defines the tool's output, second provides actionable guidance. Information is front-loaded and every sentence serves a purpose.

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 the tool's complexity (3 params, no output schema), the description covers purpose, usage timing, and a critical caution about large databases. It does not detail output structure or error scenarios, but is sufficient for a metadata discovery tool.

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 100%, and the description adds value by explaining the purpose of parameters like db (database code) and limit (with specific guidance for large databases). It also mentions 'layer structure' in context, enriching the understanding 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?

Description clearly states 'Get metadata (series codes, names, units, frequencies, layer structure) for a BOJ database', specifying the verb and resource. It differentiates from siblings by indicating this is for discovering structure before fetching data, unlike boj_list_databases, boj_get_data_code, or boj_get_data_layer.

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?

The description advises using this tool to discover available series codes before fetching data, and includes a specific caution for large databases (e.g., CO/Tankan) to use small limits. It lacks explicit exclusion criteria or direct comparison with siblings, but the context implies when to use it.

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