get_codelist

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

Although the annotations provide the readOnlyHint, the description adds specific behavioral context by mentioning what details will be returned (definition, extensibility). This provides the AI with a better idea of the output content than the schema alone.

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 definition is highly efficient. It front-loads the most important routing advice and uses a concrete example immediately afterward, making it highly digestible and actionable.

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 complexity of the CT framework (package names, codelist formats, multiple related tools), this definition is exceptionally complete. It covers how to find the inputs (package/codelist) and what the resulting data structure entails (raw vs. slim response).

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?

Since schema coverage is 100%, the description must add context. It excels here by adding vital constraints on required parameters—specifically defining the format of the codelist ID, suggesting fallback tools (get_variable, get_codelists) if the ID is unknown, and explaining the practical difference between 'raw' and 'slim' responses.

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 explicitly states the function is to retrieve detailed information about a specific codelist. Crucially, it distinguishes this tool from its siblings by providing clear routing instructions: use get_codelist_terms for all terms and get_codelist_submission_values for submission values.

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 definition provides comprehensive usage guidance by not only suggesting alternative tools based on the user's specific need (e.g., terms vs. submissions) but also by warning against using the tool incorrectly (i.e., guessing the codelist ID).

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