Skip to main content
Glama
OpenRGB Status Light MCP

OpenRGB Status Light MCP

by sheetung

Show current lamp state

status
Read-only

Reports the current lamp state, including LED count, device, SDK port, animation activity, progress/quota, and last error for troubleshooting.

Instructions

Report the current lamp state: state, LED count, device, SDK port, whether the animation is running, active progress/quota and the last error.

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": "status"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

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.7/5.0
Behavior3/5

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

readOnlyHint=true and openWorldHint=false already establish that this is a safe, local read, so the description carries a lighter burden. What it adds is the scope of the snapshot (state, LED count, device, SDK port, animation flag, progress/quota, last error), but it says nothing about freshness or whether calling it has side effects on the device or animation.

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?

One front-loaded sentence with no filler. The field list is longer than minimal, but each item tells the agent what a status snapshot contains.

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?

For a zero-argument, read-only tool with an output schema and clear annotations, the description is sufficient. Its only shortfall is that it does not indicate what calling it does to a running animation, if anything.

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?

The tool takes no parameters, so the baseline of 4 applies; there is no argument meaning for the description to supply.

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?

A specific verb ('Report') on a specific resource (the current lamp state), followed by an enumeration of the state fields returned. That reads clearly as a read-only snapshot tool, distinguishable from the set_* siblings, though it never names a sibling explicitly.

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?

Usage is only implied: the inclusion of 'active progress/quota' and 'last error' hints at diagnostics and health checks, but there is no statement of when to call this instead of, say, list_devices or restore, and no prerequisites or exclusions.

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