Skip to main content
Glama

iaqualink_list_onetouch

Read-only

Lists a Jandy AquaLink RS panel's OneTouch scenes, including each scene's number, label, and on/off state, so you can identify macros to run or stop.

Instructions

List a Jandy AquaLink RS panel’s OneTouch scenes — the panel-defined one-button macros such as "Spa Mode", "All OFF" or "Clean Mode" — with each scene’s number, label and whether it is on, read through iAqualink WebTouch (the panel emulation). Use iaqualink_set_onetouch to run or stop one.

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_onetouch"
  }
}

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.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered; the description adds that scenes are panel-defined on the physical panel, are read through the WebTouch emulation, and that results carry number, label and on/off state — useful return-shape context given there is no output schema. It does not mention failure modes (bad serial, panel offline), which keeps it below a 5.

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?

Two sentences, front-loaded with the action and resource, with the sibling reference placed last where it belongs. The em-dash appositive is dense but each clause carries information; a slightly tighter phrasing would earn 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 one-parameter read tool with full annotation coverage, the definition supplies purpose, domain vocabulary, read mechanism, result fields and the follow-up tool. Only error/edge-case behavior is unaddressed, which is a minor gap for this complexity level.

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?

With a single parameter at 100% schema description coverage, the schema already explains serial and even points to iaqualink_list_systems as the source. The description adds nothing parameter-specific beyond that, so the baseline 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?

"List a Jandy AquaLink RS panel's OneTouch scenes" states a specific verb and resource, then defines the domain term with concrete examples ("Spa Mode", "All OFF", "Clean Mode") and names the transport (WebTouch panel emulation). An agent can distinguish this read tool from iaqualink_set_onetouch and from status/list tools without opening the schema.

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?

The final sentence explicitly routes the agent to iaqualink_set_onetouch "to run or stop one", giving a clear use/alternative pairing. There is no explicit statement of when this tool should not be used (e.g. versus iaqualink_get_status for general panel state), but the scope is narrow enough that misuse is unlikely.

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