mike_set_values

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

Discloses mutation, return of before/after, requirement to use a copy, and license needs. No annotations exist, so description carries full burden and provides essential behavioral context beyond the input schema.

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 well-structured sentences: main purpose, return info, then warnings and usage. Every sentence adds value without redundancy. Front-loaded with action and resource.

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?

Covers main usage, mutation warning, and return type (before/after). Lacks detail on error handling or return format details, but adequate for a mutation tool with 5 parameters and no output schema given the clear warnings.

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?

Description adds meaning to muids (scope the change), all (update all rows, use with care), and values (column-value pairs). However, sqlite and table parameters are not elaborated beyond schema. With 60% schema coverage, description partially compensates but leaves some gaps.

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 'Set' and the resource 'parameter values in a MIKE+ table' with specific scope (element MUIDs). Examples (pipe Diameter, Manning roughness) clarify the function. It distinguishes from sibling tools like mike_get_values by specifying mutation and return of before/after.

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?

Explicitly states when to use ('Set parameter values'), warns about mutation ('ALWAYS use a copy'), and distinguishes between scoped updates (muids) and bulk updates (all=true). Also notes prerequisite: 'Needs MIKE+ + license'.

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