Skip to main content
Glama

Set an object property

gma3_set_property

Sets a property on a grandMA3 show object through the Lua Set() API using an object reference, property name, and editor-style value; modifies the show file.

Instructions

Set a property of a show object via the Lua Set() API, e.g. ref 'Sequence 1', property 'Name' or 'Tracking'; ref 'Sequence 1 Cue 2', property 'TrigTime'. Values are passed as text the way they would be typed in the editor (e.g. 'Yes', 'No', '2.5', 'Follow'). This modifies the show file.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refYesObject reference. Either command-line object syntax ("Sequence 1", "Sequence 1 Cue 3", "Fixture 101", "Group 5", "Macro 2", "Page 1.201"), a dotted show-data path from a root ("DataPool.Sequences", "Root.ShowData", "Patch.Fixtures"), a numeric address like "14.14.1.6.1", or one of: Root, ShowData, DataPool, SelectedSequence, CurrentCue, Patch, Programmer, Selection, CurrentExecPage.
valueYes
propertyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose the critical trait that the operation 'modifies the show file' and that values are supplied as editor-typed text. It omits error behavior, whether changes are undoable, permission requirements, and how invalid property names or values are handled.

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?

Three sentences, purpose front-loaded, with examples carrying the detail efficiently. Little waste, though the sentence about values-as-text and the mutation note could be tightened.

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

Completeness3/5

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

For a mutation tool with no annotations and no output schema, the description adequately covers purpose, mechanism, and arg examples, but leaves gaps on error behavior, permission needs, and differentiation from sibling setters that a fully complete definition would address.

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 only 33% (only 'ref' is documented), so the description must compensate, and it largely does: it clarifies that 'value' is passed as text exactly as typed in the editor and supplies representative property names ('Name', 'Tracking', 'TrigTime'). It adds real meaning beyond the bare schema, though it doesn't enumerate valid property strings comprehensively.

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+resource (set a property of a show object) and grounds it in the Lua Set() API with concrete examples like 'Sequence 1'/'Name' and 'Sequence 1 Cue 2'/'TrigTime'. However, it never distinguishes itself from close siblings such as gma3_set_attribute, gma3_set_color, gma3_set_cue_timing, or gma3_patch_set, so the agent can't easily tell which setter to reach for.

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

Usage Guidelines2/5

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

Provides usage examples of property/ref pairs but gives no when-to-use vs when-not guidance and names no alternative setter. The agent gets no rule for choosing this generic setter over the many specialized set_* siblings.

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