xmlquery

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

No annotations are present, so the description carries full burden. It describes the command execution and return value, but omits behavior on missing variables, invalid case_dir, or if the operation is idempotent and safe. Basic traits are covered, but depth is insufficient.

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 very concise: three sentences that front-load the purpose, then details. No wasted words, efficient structure.

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?

With two required parameters and no annotations, the description covers the basic workflow but lacks information on error handling, prerequisites (e.g., valid case directory), and output format despite an output schema existing. Adequate but not comprehensive.

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 description coverage is 0%, so description must compensate. It adequately explains the variable parameter with case sensitivity and the special --listall value, but does not describe the case_dir parameter beyond its role in the command. Partial compensation.

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 queries a CESM XML configuration variable, with specific verb and resource. Examples are provided, but it doesn't explicitly differentiate from sibling tools like xmlchange.

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 implies usage for querying variables and mentions case sensitivity and the --listall option. However, it lacks guidance on when to use vs alternatives or when not to use, e.g., for modification use xmlchange.

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