Skip to main content
Glama

iaqualink_set_aux

Idempotent

Turn a pool or spa auxiliary circuit on or off by number, name, or label, with confirmation and a state re-read to verify the change.

Instructions

Turn an auxiliary circuit on or off — cleaner, waterfall, bubbler, landscape or pool/spa lights wired to an aux relay. Identify it by number ("3"), name ("aux_3") or label as shown by iaqualink_get_status. On iAqua, dimmable lights turn on at 100% and color lights at their first color, as the iAqualink app does. Sends nothing if already in that state, then re-reads to confirm. 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>",
      "aux": "<aux>",
      "on": "<on>"
    },
    "name": "iaqualink_set_aux"
  }
}

Input Schema

NameRequiredDescriptionDefault
onYestrue = turn on, false = turn off
auxYesAux number, aux_<n> name, or label
serialYesSystem serial number, from iaqualink_list_systems
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.1/5.0
Behavior5/5

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

Goes well beyond the annotations: discloses the no-op behavior when already in the requested state, the re-read-to-confirm step, and the device-specific side effects (dimmable lights go to 100%, color lights to first color). It also describes the confirmation gate and the preview/confirmToken fallback, which is exactly the kind of safety context a mutation tool needs beyond idempotentHint and destructiveHint.

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 action and examples, then proceeds to identification, side effects, and the confirmation flow in a logical order. Some of the confirmation detail restates what the confirmToken schema already says, and 'see MCP_CONFIRM_MODE' is an external pointer rather than self-contained text, keeping it from a 5.

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 state-changing tool with no output schema, it covers the crucial gaps: confirmation requirements, no-op behavior, implicit state after on, and verification re-read. It does not describe the shape of the returned status or the preview payload, and defers confirmation-mode specifics to an external document, leaving a small residual gap.

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 description coverage is 100%, so all four parameters, including confirmToken and its constraints, are already documented in the schema. The description adds the accepted aux identifier formats, but that is largely duplicative of the schema's own 'Aux number, aux_<n> name, or label' wording. Baseline 3 is appropriate.

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?

States a specific verb and resource (turn an auxiliary circuit on/off) and enumerates concrete examples (cleaner, waterfall, bubbler, landscape or pool/spa lights wired to an aux relay). It does not explicitly tell the agent when to prefer the sibling iaqualink_set_light instead, which matters because it mentions lights, so it falls short of full sibling differentiation.

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

Usage Guidelines4/5

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

Gives clear invocation context: identify the circuit by number, aux_<n> name, or label sourced from iaqualink_get_status, and always confirm with the user first. It explains the two-path confirmation flow in detail. It does not state exclusions or name competing tools for overlapping cases (e.g. dedicated light control).

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