Skip to main content
Glama

Set a fixture attribute

gma3_set_attribute

Set a fixture attribute such as Dimmer, Pan, or Zoom to an absolute value in the grandMA3 programmer for specified fixtures or the current selection.

Instructions

Set one attribute (Dimmer, Pan, Zoom, ColorRGB_R, ...) to an absolute value in the programmer. Sends Attribute "<name>" At Absolute [<unit keyword>] <value> after establishing the target. Target is explicit: fixtures (range/group) OR use_selection: true. With fixtures the tool sends ClearSelection and then SELECTS exactly those fixtures (the selection changes; previously selected fixtures are not affected unless add_to_selection is true). Never clears programmer values. Without unit the number is interpreted by the user profile's readout. Small explicit targets are pre-checked against the fixture type's attribute list (check_attributes), and after setting, the programmer is read back and compared per fixture in the unit sent (verify); a fixture without the attribute is a mismatch, not a success. Serialised against this server's other mutations only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
unitNoValue-type keyword sent with At: percent, percent_fine, physical (degrees/Hz/rpm), natural (attribute's natural readout), decimal8/16/24. Omit to use the console's current readout.
valueYesAbsolute value. Range depends on unit: percent/percent_fine 0..100, decimal8 0..255, decimal16 0..65535, decimal24 0..16777215, physical/natural any finite number.
verifyNoRead the programmer back after setting (default true): every targeted fixture must hold the value, compared in the unit it was sent in (percent of the attribute range, tolerance 0.5 %). A fixture without the attribute is reported as a mismatch. Needs plugin 0.3.2 or newer; older plugins yield verification 'unavailable'.
fixturesNoExplicit target: fixture IDs/ranges ("1 Thru 5", "1 + 3 + 5 Thru 8", "Fixture 101.1") or a group ("Group 5"). Exactly one of fixtures / use_selection is required.
attributeYesAttribute name as grandMA3 shows it, e.g. "Dimmer", "Pan", "Tilt", "Zoom", "ColorRGB_R" (letters, digits, _ and . only).
use_selectionNoApply to the fixtures currently selected on the console (explicit opt-in). Fails before sending when nothing is selected.
add_to_selectionNoWith `fixtures`: keep the fixtures already selected and add the target to them, so previously selected fixtures ALSO receive the values (explicit opt-in). Default false: ClearSelection is sent first so exactly the named fixtures are targeted. ClearSelection only deselects; programmer values are never cleared.
check_attributesNoWith `fixtures` resolving to at most 8 fixtures (default true): check each fixture type's attribute list first and fail before sending when a fixture lacks the attribute. Skipped for groups and larger targets.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior5/5

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

No annotations exist, so the description carries the full burden and does: it discloses that ClearSelection is sent and the selection changes, that previously selected fixtures are untouched unless add_to_selection is true, and that programmer values are never cleared. It also spells out the pre-check/verify pipeline and the mismatch-is-not-success rule, which an agent could not infer from the schema.

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 purpose in the first sentence and then walks through targeting, side effects, and verification in a logical order. Dense but each sentence carries information; the final serialisation note and a few packed clauses edge it just below maximum readability.

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

Completeness5/5

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

For an 8-parameter mutation tool with no annotations and no output schema, the description covers what an agent needs: how to target, what mutations occur to the selection and programmer, how failures are surfaced (pre-check failure, verification mismatch), and version constraints for verify. Nothing critical to correct invocation is missing.

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 adds real meaning: the effect of omitting `unit` (interpreted by the user profile's readout), the selection side effect of `fixtures`, and the dependency of `check_attributes` on target size. These are behavioural couplings the per-property schema text only partially conveys.

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 ('Set'), a bounded resource ('one attribute ... to an absolute value in the programmer'), and gives concrete examples (Dimmer, Pan, Zoom, ColorRGB_R). It also names the underlying command sent, so the mechanism is unambiguous. It never explicitly differentiates from nearby siblings that also write values (gma3_set_color, gma3_set_position, gma3_set_property), so it lands at clear-but-not-differentiating.

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 operating context: the target must be explicit via `fixtures` OR `use_selection: true`, when the pre-check applies (small explicit targets, <=8 fixtures), when verification runs, and that the operation is serialised against this server's other mutations. It stops short of saying when to prefer this over gma3_set_color/gma3_set_position or gma3_command, so no explicit alternative routing.

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