nomis_dimension_options

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

No annotations are provided, so the description carries the full burden. It explains the tool lists codes and describes the search parameter, but does not explicitly state it is a read operation, mention error handling, or discuss rate limits. Adequate but not comprehensive.

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 with only a few sentences, uses backticks for parameter names, and presents key information 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?

Given an output schema exists, the description need not detail return format, but it already mentions value and human name. It covers main purpose, parameters, and an alternative tool. Could mention pagination or limit behavior, but overall very informative for a tool with no annotations.

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 0%, so the description must compensate. It explains the 'dimension' parameter as the conceptref from nomis_get_dataset with examples, and the 'search' parameter as an optional substring filter. However, it does not explain 'dataset_id' or 'limit' (limit is self-explanatory but not described). Adds value for two out of four 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?

The description clearly states the tool lists valid codes for one dimension of a Nomis dataset, specifying it returns a value and human name. It distinguishes from the sibling tool nomis_geography_search for geography use.

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 explicitly says when to use this tool (listing valid codes for a dimension) and provides an alternative (nomis_geography_search for geography). It also notes the search parameter is useful for large codelists.

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