xmlchange

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

Describes only that it runs ./xmlchange from the case directory with an example. No mention of side effects, required state of the case, or error conditions. With no annotations, this 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?

Three concise sentences with clear structure: purpose, example, advisory. No wasted words.

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?

Missing return value description (despite output schema existing) and prerequisites like case_dir validity. For a change tool with no annotations, more context is needed.

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?

Adds meaning for 'variable' and 'value' via the example, but 'case_dir' is not explained. Schema coverage is 0%, so 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?

Clearly states 'Change a CESM XML configuration variable' with an example. Distinguishes from sibling xmlquery by recommending its use first.

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?

Recommends using xmlquery before changing, providing a usage guideline. However, does not elaborate on when it is appropriate to change variables or what prerequisites must be met.

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