Skip to main content
Glama
OpenRGB Status Light MCP

OpenRGB Status Light MCP

by sheetung

Run a hardware effect of the device

set_effect
Idempotent

Switches LED control to a device-native effect such as Static, Breathing, or Wave, pausing the status animation until a state update resumes it.

Instructions

Hand the LEDs over to one of the device's own effects (for example 'Static', 'Breathing', 'Wave' - the available names depend on the device and are listed by list_devices). This stops the status animation; call set_state again to resume it.

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": {
      "effect": "<effect>"
    },
    "name": "set_effect"
  }
}

Input Schema

NameRequiredDescriptionDefault
colorNo
effectYes

Output Schema

NameRequiredDescriptionDefault
fpsYes
portYes
quotaNo(remaining, total)
ratioNo
stateYes
totalNo
zonesNo
agentsNoall agents currently sharing the lamp
detailYes
deviceYes
animateYes
controlNo'global' = the whole strip is controlled as one unit, 'per_led' = every LED is written individuallyglobal
percentNo
agent_idNoid of this agent in the shared registry
progressNo0..1
restoredNo
led_countYes
remainingNo
brightnessYes
last_errorYes
active_modeYes
filled_ledsNo
render_modeNo'hardware' = the controller animates on its own, 'per_led' = colours are written LED by LEDper_led
state_age_sYes
custom_colorYes
display_stateNostate currently shown on the lamp (highest priority of all agents)idle
protocol_versionYes
animation_runningYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover safety (readOnlyHint=false, idempotentHint=true, destructiveHint=false), so the bar is lower, and the description still adds real behavior: this replaces the status animation, which stays off until set_state is called, and effect names are device-dependent. What is missing is any note on what happens to an in-progress animation state or error behavior for unsupported effect names.

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

Conciseness5/5

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

Two sentences, front-loaded with the action and its examples, then the side effect and recovery path. No filler or restated title.

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?

An output schema exists, so return values need no explanation, and the interaction with set_state is spelled out. The remaining gap is the undocumented 'color' parameter and the fact that valid effect names must be fetched from a separate tool, which adds a step the agent only learns implicitly.

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 0%, so the description must carry parameter meaning. It does well for 'effect' (device-dependent names, discoverable via list_devices) but says nothing about the optional 'color' parameter or its format, leaving half the surface undocumented.

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?

States a concrete action (hand the LEDs over to a device-native effect) with examples of effect names, and explicitly distinguishes it from the status animation that set_state drives. An agent can tell it apart from set_state/set_color without opening either 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?

Gives clear use context (device-native effects like 'Static', 'Breathing', 'Wave') and a concrete follow-up rule: call set_state again to resume the status animation. It also points to list_devices for valid effect names. It stops short of stating when NOT to use it versus set_color/set_leds, but the status-animation tradeoff is the main routing decision and it is covered.

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