Skip to main content
Glama

iaqualink_set_equipment

Idempotent

Turns pool or spa equipment on or off, checking current state first to avoid toggle mistakes and re-reading to confirm the change. Use it to switch pumps, heaters, chlorinator output, boost or low mode.

Instructions

Turn pool equipment on or off. iAqua (Jandy iAquaLink) systems: pool_pump, spa_pump, pool_heater, spa_heater, solar_heater. eXO salt chlorinators: filter_pump, production (chlorine generation), boost, low (low-output mode), heating. Reads the current state first and sends nothing if it already matches (iAqua commands are toggles); afterwards re-reads to confirm the change landed. Asks the user to confirm first: a confirmation prompt where the client supports one; otherwise the first call returns a preview and a confirmToken, and only a repeat call with that token proceeds (see MCP_CONFIRM_MODE).

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>",
      "equipment": "<equipment>",
      "on": "<on>"
    },
    "name": "iaqualink_set_equipment"
  }
}

Input Schema

NameRequiredDescriptionDefault
onYestrue = turn on, false = turn off
serialYesSystem serial number, from iaqualink_list_systems
equipmentYesWhich equipment to switch
confirmTokenNoONLY for the two-step confirmation fallback (a client without MCP elicitation). The confirmToken from this same tool's phase-1 "confirmation-required" response, passed back ONLY after the user has seen that preview and explicitly approved it in chat — never on the first call, never invented, never reused. Call again with the same arguments. Ignored when the client supports elicitation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: it reads current state first, sends nothing if the state already matches (explaining why idempotentHint=true despite the underlying toggles), and re-reads afterward to confirm the change landed. It also discloses the two-phase confirmation requirement, the confirmToken contract, and the MCP_CONFIRM_MODE dependency — exactly the kind of auth/side-effect context an agent needs before mutating a device.

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

Conciseness4/5

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

Front-loads the core action, then system-specific values, then the read-verify-confirm behavior — a sensible order with no filler. It is dense (three sentences packing a lot of clauses) but every sentence carries operational information; only the MCP_CONFIRM_MODE cross-reference is slightly cryptic without that doc.

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 4-parameter mutation tool with no output schema, the description covers state pre-checks, confirmation, post-verification, and per-system valid values. What it omits is what a successful response actually contains (status payload, resulting state) and what failure looks like, which an agent must discover at call time.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description goes further by annotating enum members ('production (chlorine generation)', 'low (low-output mode)') and explaining the system-specific grouping of equipment values. The confirmToken discipline is described in both places; the description reinforces rather than duplicates it.

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

Purpose4/5

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

Opens with a concrete verb+resource ('Turn pool equipment on or off') and then enumerates exactly which equipment identifiers belong to iAqua vs eXO systems, so an agent knows the scope without opening the schema. It does not name the sibling that handles related-but-different operations (iaqualink_set_chlorinator overlaps with 'production'/'boost', iaqualink_set_aux with aux circuits), so differentiation is inferred rather than stated.

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

Usage Guidelines3/5

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

Usage is implied by the equipment list and the confirmation workflow is spelled out well (client prompt vs preview+confirmToken fallback). However, there is no explicit when-to-use/when-not guidance against siblings such as iaqualink_set_chlorinator for production levels or iaqualink_set_pump_speed for speed changes, leaving real ambiguity for an agent choosing between them.

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