set_pump_speed

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

No annotations provided, so description carries full burden. It only describes the action and parameter meanings but omits side effects, idempotency, or whether the network must be loaded. Insufficient for safe invocation.

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?

Concise: two sentences and a parameter list. Purpose is front-loaded. No extraneous words, but could be more structured with explicit sections.

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?

Minimal context given the complexity and many sibling tools. Does not mention return values (output schema exists but unused), prerequisites, or error conditions. Incomplete for a safe agent workflow.

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%, but description adds meaning: 'network_id: Session id', 'pump_id: Pump link name/ID', 'speed: Speed ratio (1.0 = design speed, 0.5 = half speed)'. This compensates partially, but no details on constraints or allowed ranges.

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 'Set the relative speed setting of a pump' with a specific verb and resource. It distinguishes from siblings like ‘set_pump_status’ and ‘set_pump_head_curve’, though not explicitly. The meaning is clear.

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?

No guidance on when to use this tool versus alternatives. It does not mention prerequisites, scenarios, or exclusions. Without context, the agent must infer usage.

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