case_setup

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

No annotations provided, so description carries full burden. Discloses file generation, clean flag behavior, container usage, and order dependency. Lacks details on side effects, errors, or persistence requirements.

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?

Four concise sentences: primary action, outputs, optional flags, prerequisite. No unnecessary words. Front-loaded with key information.

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 existence of output schema (not shown), description is fairly complete: covers purpose, outputs, special flags, and ordering. Could mention return value or log location but not critical for a setup tool.

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 0%, description compensates by explaining 'clean' and 'container' parameters. 'case_dir' is implicit but unambiguous. Adds value beyond schema.

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 action (run ./case.setup), resource (CESM case), and generated outputs (namelists, batch scripts, env_mach_specific.xml), distinguishing from siblings like case_build.

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?

States prerequisite (must run before case_build) and explains optional parameters (clean, container). Does not explicitly specify when not to use or contrast with other setup options.

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