Skip to main content
Glama

iaqualink_list_pump_speeds

Read-only

Lists a Jandy AquaLink RS panel’s named variable-speed pump speeds, RPMs, and active speed via iAqualink WebTouch so you can check state before changing or scheduling pump operation.

Instructions

List a Jandy AquaLink RS panel’s variable-speed pump speeds — the named speeds (e.g. Pool, Spa, Cleaner) with each one’s RPM and which one the pump runs at — read through iAqualink WebTouch from the panel’s "VSP Adjust / Set Speed" screen. Use iaqualink_set_pump_speed to switch speeds and iaqualink_set_pump_speed_rpm to change a speed’s RPM.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "serial": "<serial>"
    },
    "name": "iaqualink_list_pump_speeds"
  }
}

Input Schema

NameRequiredDescriptionDefault
serialYesSystem serial number, from iaqualink_list_systems

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered structurally; the description adds value by disclosing the retrieval path (iAqualink WebTouch, panel's VSP Adjust / Set Speed screen) and the fields returned, with no output schema present. It stops short of stating failure modes such as a panel being offline or having no variable-speed pump installed, which is the only remaining gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with what is listed and what is returned, followed by a compact routing clause. No filler, no restatement of the title or annotations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read-only list tool with no output schema, the description covers purpose, return contents, data source, and sibling routing — enough for correct invocation. Minor omissions are behavioral edge cases (no VSP configured, panel unreachable) rather than anything needed to select the tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single `serial` parameter is already documented there, including its provenance (from iaqualink_list_systems) and format constraints. The description adds no further parameter-level meaning, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Uses a specific verb ("List") on a specific resource (a panel's variable-speed pump speeds) and even enumerates the returned shape — named speeds such as Pool/Spa/Cleaner with RPM and which speed is active. It also names the data source screen ("VSP Adjust / Set Speed"), which makes it instantly distinguishable from the two set_* pump siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes the agent to alternatives with their conditions: use iaqualink_set_pump_speed to switch speeds and iaqualink_set_pump_speed_rpm to change a speed's RPM. This is exactly the read-vs-write disambiguation an agent needs among three similarly named pump tools.

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