Skip to main content
Glama

Read console feedback state

gma3_feedback

Read grandMA3 console feedback without changing state—command line, playback, preview, executors, faders, sequences—even when input is disabled or another client controls it.

Instructions

Read-only console state for feedback (KB-06): command-line text, last command feedback, Blind/Highlight/Solo, Preview mode, a display's Preview bar, keyboard-shortcut enablement, aggregate MA state, current executor page, selected sequence, and per executor the assignment and fader level, per sequence its playback activity. Works with gma3_lua disabled, with console input disabled and while another client holds an input interaction; it acquires nothing and changes no console state (selection, command line, programmer, playback, focus). Every item carries available, value (null when unavailable, with a reason or error; false is an observed value), scope, source, observedAt and epoch. Items are read one after another, not as an atomic snapshot. lastCommand and maState are shared observations, not confirmation of a request or key owner; sequenceActive is playback activity, not executor button state; Freeze has no readable state and is always unavailable. With no arguments every parameterless reader is read (previewBar on display 1). Bridge op feedback.read (plugin >= 0.8.0).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
readersNoReaders to include. Parameterised readers (executor, fader, sequenceActive) come from executors/sequences instead. Omit everything to read all parameterless readers.
displaysNoDisplay indexes for previewBar (one item per display; a missing display is reported unavailable) (at most 8 per call; a longer list is refused up front)
executorsNoExecutor numbers on the user's current page: assignment (executor) and master level (fader) per number (at most 32 per call; a longer list is refused up front)
sequencesNoSequence numbers: playback activity (sequenceActive) per number (at most 32 per call; a longer list is refused up front)
fader_tokensNoFader tokens read per executor (default ['FaderMaster'])

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?

With no annotations the description carries the full burden and does so thoroughly: it changes no console state (selection, command line, programmer, playback, focus), reads items sequentially rather than as an atomic snapshot, flags lastCommand/maState as shared observations rather than request confirmation, distinguishes sequenceActive from executor button state, and warns Freeze is always unavailable. It also documents per-item fields (available, value, scope, source, observedAt, epoch) and that null means unavailable while false is a real observed value.

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

Conciseness3/5

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

Information-dense and front-loaded with the readable items, but delivered as one long multi-clause paragraph with heavy parenthetical asides, which hurts scanability for an agent. Little is outright redundant, but the packing is dense enough that structure suffers.

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 a 5-parameter, enum-heavy tool with no output schema, the description compensates by explaining the shape of returned items and their semantics (available/value/scope/source/observedAt/epoch, null vs false). Combined with the acquisition and interaction caveats, an agent has everything needed to call and interpret it.

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 genuine semantic value: it clarifies that executor/fader/sequenceActive readers are parameterised and sourced from executors/sequences, that fader_tokens defaults to ['FaderMaster'], and that previewBar defaults to display 1. It also documents the meaning of the returned value semantics, which the schema cannot.

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?

Names a specific verb and resource (read-only console feedback state) and enumerates the exact readable quantities (command-line text, last command, Blind/Highlight/Solo, Preview, shortcuts, MA state, page, executor/fader/sequence activity). An agent can tell this is a state-reader apart from write-oriented siblings like gma3_command or gma3_set_fader 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 Guidelines3/5

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

Gives real deployment context — works with gma3_lua disabled, with console input disabled, and while another client holds an input interaction, and it acquires nothing. However it never says when to prefer it over siblings such as gma3_status or gma3_hardkeys_status, and the no-argument default behavior ('every parameterless reader is read') is stated but not framed as guidance.

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