list_all_allowances

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

With no annotations, the description carries full burden. It discloses the operation type (list) and data types (allowances, TOIL, carry-forward), but omits details like read-only nature, pagination, ordering, or potential rate limits. The description is adequate but not rich.

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 two sentences with front-loaded purpose. Every sentence provides distinct value: the first states the tool's function, the second explains the optional parameter. No waste.

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?

For a simple list tool with one optional parameter and no output schema, the description is complete enough. It states what is listed and how to filter by year. It could mention return structure or ordering, but not strictly necessary given 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 coverage is 0%, so description must add meaning. It explains the 'year' parameter: 'Restrict to a single year. Omit for all years.' This adds clarity beyond the schema's default null. Since only one parameter exists and it's well described, score is high.

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 verb 'List' and the resources 'allowances, TOIL and carry-forward for all users'. It distinguishes from sibling tools like get_user_allowance (per-user) and update_user_allowance (mutation) by specifying the scope 'all users'.

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 provides guidance on the optional 'year' parameter (restrict to a single year or omit for all), but does not compare with siblings or state when to use this tool versus others like list_absences or list_holidays.

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