Skip to main content
Glama
OpenRGB Status Light MCP

OpenRGB Status Light MCP

by sheetung

Show task progress as an LED bar

set_progress
Idempotent

Turn an OpenRGB LED strip into a progress bar by specifying percent or done/total; completed LEDs stay lit, remaining LEDs dark, with optional color and state.

Instructions

Turn the LED strip into a progress bar: the completed part is lit, the rest is dark.

Pass percent (0-100) or both done and total. color overrides the bar colour (#RRGGBB). state selects the palette entry (default 'working').

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "set_progress"
  }
}

Input Schema

NameRequiredDescriptionDefault
doneNo
colorNo
stateNoworking
totalNo
detailNo
percentNo

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

A3.5/5.0
Behavior3/5

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

Annotations already establish that this writes device state (readOnlyHint=false), is idempotent, and is non-destructive, so the description only needs to add context. It adds the visual semantics (lit vs dark segments) and the default palette entry ('working'), which are useful. It stays silent on persistence (does the bar remain until replaced?), interaction with set_effect/set_color, and whether a device must be connected, which matters for a stateful display call.

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 short sentences, front-loaded with what the tool produces, then the input contract. Every sentence carries information and there is no filler. The colour spelling and sentence fragments are slightly informal but do not impede reading.

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?

An output schema exists, so return values need no explanation, and the visual behaviour plus five of six parameters are covered. Gaps remain for a six-parameter device tool: 'detail' is undocumented, and the valid values behind 'state' are not enumerated anywhere since the schema has no enums and no descriptions. An agent could call it correctly for the common case but not fully explore the API.

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 description coverage is 0%, so the description carries the full burden and largely meets it: it defines percent as 0-100, explains that done and total are an alternative encoding of the same value, gives the #RRGGBB format for color, and notes state selects a palette entry with default 'working'. Only 'detail' is left completely undefined, which prevents a 5.

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?

The description states a specific verb and resource: turn the LED strip into a progress bar with the completed portion lit and the remainder dark. The visual result is unambiguous. It does not explicitly distinguish itself from similar display siblings such as set_quota, leaving the caller to infer which one to use for which kind of progress.

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?

Usable guidance is implied by the two accepted input modes ('pass percent (0-100) or both done and total'), which tells an agent how to call it. However, there is no statement of when this should be used instead of set_quota, set_color, or set_state, and no exclusions or prerequisites. Usage context must be inferred from the name and siblings.

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