opendeck-mcp

Overview Schema Source Related Servers Discussions Admin

update_key

Change an existing key's title, image, settings, or state without replacing its action; live changes apply instantly, others are staged.

Instructions

Change an existing key without replacing its action: title, title style, image, settings, or which state it shows.

Title text, image and settings changes on the profile a connected device is showing apply instantly, with no restart (undo with undo_live). Anything else (title style, current state, another profile, a device with staged changes) is staged for apply_changes; the result says which happened. A live settings change reaches the plugin as if edited in OpenDeck's own panel; if that key's settings panel is open in OpenDeck, reopen it to see the change.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`mode`	No	auto: apply instantly when possible, else stage; live: instantly or fail; staged: always stage.	auto
`slot`	Yes	Slot, or <slot>/child<N> for a child.
`image`	No	Key image: a file path, an http(s) URL, or a data: URL; 'default' restores the action's own.
`state`	No	Which state to restyle (0-based) for multi-state actions; default all.
`title`	No
`device`	Yes	Device id or name, e.g. 'ulanzi-d200h' (see get_overview).
`profile`	No	Profile id; defaults to the device's selected profile.
`title_style`	No	Title look: show (bool), colour (#RRGGBB), size (int), family (font), style (Regular\|Bold\|Italic\|Bold Italic), alignment (top\|middle\|bottom), underline (bool), stroke_colour, stroke_size, background_colour.
`current_state`	No
`settings_merge`	No	Merged into the settings (JSON merge patch: null deletes a key).
`remove_settings`	No
`settings_replace`	No	Replaces the settings entirely.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.4.0Oct 16, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations mark this as non-read-only, non-destructive, non-idempotent, but the description goes further: it explains the live-vs-staged routing, that live edits land on the plugin as if edited in OpenDeck's own panel, and that an open settings panel must be reopened to see the change. Those are exactly the behavioral traits annotations cannot convey.

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 dense but well-ordered sentences: purpose first, then the routing rule, then the panel caveat. Every sentence carries information, though the panel-reopening aside is somewhat niche detail layered on an already long description.

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 12-parameter mutation tool with an output schema present, the description covers the significant unknowns: how changes are applied, how to undo, and what the result tells you. Nothing an agent needs to invoke it correctly appears missing.

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 75% and the schema itself documents mode, slot, image, state, profile, title_style, settings_merge etc. in detail, so the description adds useful framing rather than raw syntax – it tells the agent which parameters drive the live vs staged decision. It doesn't enumerate the settings-merge/replace/remove triple, but the schema handles that.

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 specific verb+resource ('Change an existing key') and immediately bounds the scope with 'without replacing its action,' which cleanly separates it from set_key/clear_key. A list of the mutable attributes follows, so an agent knows exactly what this tool edits.

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

Usage Guidelines5/5

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

Explicitly partitions what applies instantly (title text, image, settings on the connected device's profile) from what is staged for apply_changes (title style, current state, other profiles, staged devices), and names the alternatives undo_live and apply_changes. This is a textbook when/when-not/alternatives breakdown.

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