io.github.verygoodplugins/streamdeck-mcp MCP Server
io.github.verygoodplugins/streamdeck-mcp
AI-powered Elgato Stream Deck profile builder—design buttons, pages, and automations from natural language.
What is the io.github.verygoodplugins/streamdeck-mcp MCP server?
Stream Deck MCP is an MCP server that lets AI agents build and reconfigure real Elgato Stream Deck profiles with buttons, icons, dials, and shell-script automations. It reads and writes native Stream Deck profile formats, discovers installed plugins and configured actions, and generates icons and scripts offline—enabling agents to author complete decks without requiring manual plugin development.
Stream Deck MCP bridges AI agents and Elgato Stream Deck hardware by automating profile creation. Instead of manually designing buttons in the Elgato app, you describe what you want (e.g., "Slack control board" or "OBS panel") and the agent builds a polished, themed profile with native plugin actions, custom icons, and shell scripts. It integrates with other MCP servers (Slack, Home Assistant, OBS, GitHub, Hue, Spotify) to query real entities and wire them to your deck.
How to install io.github.verygoodplugins/streamdeck-mcp
Copy-paste configuration for popular MCP clients.
Tools & capabilities
Tools this server exposes to the agent.
streamdeck_find_actions— Searches configured buttons and dials across profiles and returns paste-ready native action objects for reuse.streamdeck_read_plugins— Lists installed Stream Deck plugins and their declared actions from readable plugin manifests.streamdeck_read_profiles— Lists desktop profiles, device metadata, page directories, and active profile roots from ProfilesV3 or ProfilesV2.streamdeck_read_page— Reads a page manifest and returns simplified button details plus raw native action objects.streamdeck_write_page— Creates or rewrites a page manifest with buttons, icons, and actions.streamdeck_create_icon— Generates button or touch-strip PNGs from Material Design Icons or text labels.streamdeck_create_action— Creates an executable shell script in ~/StreamDeckScripts/ and returns an Open action block.streamdeck_restart_app— Restarts the macOS Stream Deck desktop app after profile changes.streamdeck_install_mcp_plugin— Installs the bundled streamdeck-mcp Stream Deck plugin for durable encoder imagery.
Use cases
- Build a Slack control board that queries channels and status, then creates channel jumps and status toggles on your Stream Deck.
- Design a Home Assistant dashboard for a specific room, reusing existing plugin buttons and synthesizing new ones for unconfigured entities.
- Create an OBS control panel based on your actual scenes and audio inputs, mixing configured plugin actions with generated script buttons.
- Generate a themed dev deck for a GitHub repository with command buttons, PR links, and CI shortcuts.
- Compose a multi-app demo deck across Zoom, Slack, Hue, and screen recording by finding and reusing configured plugin actions.
io.github.verygoodplugins/streamdeck-mcp MCP server FAQ
Stream Deck MCP is an MCP server that lets AI agents design and build Elgato Stream Deck profiles from natural language. You describe what you want, and the agent creates a complete profile with buttons, icons, dials, and automations—using native plugin actions when available and shell scripts when needed.
Yes. Stream Deck MCP is open-source and available on PyPI. The only cost is the Elgato Stream Deck hardware itself.
Add the following to your MCP config file (~/Library/Application Support/Claude/claude_desktop_config.json on macOS or %APPDATA%\Claude\claude_desktop_config.json on Windows): {"mcpServers": {"streamdeck": {"command": "uvx", "args": ["streamdeck-mcp"]}}}. Then restart your client.
No authentication is required. Stream Deck MCP reads and writes local profile files on your machine and discovers plugins installed in the Elgato app. It works offline for icon generation and script creation.
Stream Deck MCP supports all Elgato Stream Deck models (Standard, +, + XL, Mini, etc.) and works with the macOS and Windows Elgato desktop app. A legacy USB-direct mode is available for Linux and headless setups.
Yes. When you load other MCP servers (Slack, Home Assistant, OBS, GitHub, Hue, Spotify), Stream Deck MCP can query them to discover entities and configure native plugin actions or scripts that control those services.
README (reference)
Source of truth, from the repository.
Tell your AI what Stream Deck you want. Get back a polished profile with buttons, icons, colors, dials, touch-strip art, and the shell scripts behind it. Stream Deck MCP writes the same profile format the Elgato desktop app already uses, so agents can author real local decks without making you build a Stream Deck plugin first.
It works with Claude Desktop, Claude Code, Cursor, Codex, and any MCP client that can launch a stdio server.
Quick Start
Claude Code:
claude mcp add streamdeck -- uvx streamdeck-mcp
Claude Desktop, Cursor, Codex, and other MCP clients can use the same command:
{
"mcpServers": {
"streamdeck": {
"command": "uvx",
"args": ["streamdeck-mcp"]
}
}
}
Then ask your agent for a deck:
Make me a Slack control board for my Stream Deck + XL.
For Claude Code, install the bundled designer skill for better layout, palette, hardware, and plugin-action guidance:
uvx --from streamdeck-mcp streamdeck-mcp-install-skill
Demo
<video src="https://github.com/user-attachments/assets/970c8973-f8ff-4a5d-ad48-cde3f3b1fc65"></video>
<p align="center"> <sub>Product trailer generated with Remotion, showing hardware inventory, plugin discovery, configured action reuse, and a final Stream Deck + XL reveal.</sub> </p>Features
- Profile-native authoring - reads and writes Elgato
ProfilesV3files directly, withProfilesV2fallback for older installs. - Hardware inventory - discovers profile pages, device model names, key geometry, dials, and touch-strip support before writing.
- Configured action search -
streamdeck_find_actionsscans existing profiles/pages for paste-ready plugin buttons and dials (including protected first-party Elgato plugins configured in the app). - Installed plugin discovery - scans readable Stream Deck plugin manifests with
streamdeck_read_pluginsso agents can find plugin and action UUIDs when synthesizing new actions. - Configured plugin action reuse - prefers copying existing actions via
find_actionsorstreamdeck_read_page'sbutton.rawso private Property Inspector settings stay intact. - Offline icon generation - renders button and touch-strip PNGs from about 7,400 bundled Material Design Icons, or from short text labels.
- Script-backed automations - creates executable shell scripts in
~/StreamDeckScripts/and wires them to Stream Deck Open actions when no plugin action fits. - Dial and touch-strip support - installs a minimal bundled Stream Deck plugin when needed so encoder imagery survives app restarts.
- Safe write cycle - guards against the Elgato app overwriting manifest edits by enforcing a quit, write, relaunch workflow.
Agentic Workflows
The point is not generic buttons. Prefer reusing actions the user already configured in the Stream Deck app (Hue, OBS, Home Assistant, Spotify plugins, etc.), then compose them onto a themed page. When your agent also has Slack, Home Assistant, OBS, GitHub, Hue, Spotify, or other MCP servers loaded, it can query those systems to pick the right entities — and still wire the deck through native plugin actions when available, falling back to scripts only when needed.
Try prompts like:
- "Make me a control board for Slack." Query channels, status, and unread state; create channel jumps, status toggles, read-all controls, and dials.
- "A hello-kitty-themed Home Assistant dashboard for the living room." Find existing HA plugin buttons with
streamdeck_find_actions, then lay them out with a matching visual style — or discover living-room entities via MCP and synthesize/scripts when nothing is configured yet. - "OBS control panel based on my actual scenes and audio inputs." Reuse configured OBS plugin actions when present; otherwise read scenes/sources and write scene switches, source toggles, and per-input dial controls.
- "A dev deck for this repo in Nordic colors." Read project scripts and GitHub context; create local command buttons, PR links, and CI shortcuts.
- "A Friday demo deck." Compose across Zoom, Slack, Hue, and screen recording by finding configured plugin actions first, then generating local scripts for the gaps.
Iteration is cheap: change the prompt, rerun the authoring flow, and get a new profile.
Install
The packaged entrypoint is streamdeck-mcp, run through uvx.
Cursor
Or paste into ~/.cursor/mcp.json:
{
"mcpServers": {
"streamdeck": {
"command": "uvx",
"args": ["streamdeck-mcp"]
}
}
}
Claude Desktop
Paste into ~/Library/Application Support/Claude/claude_desktop_config.json on macOS or %APPDATA%\Claude\claude_desktop_config.json on Windows, then restart Claude Desktop:
{
"mcpServers": {
"streamdeck": {
"command": "uvx",
"args": ["streamdeck-mcp"]
}
}
}
Claude Code
claude mcp add streamdeck -- uvx streamdeck-mcp
OpenAI Codex
Add to ~/.codex/config.toml:
[mcp_servers.streamdeck]
command = "uvx"
args = ["streamdeck-mcp"]
Other MCP Clients
Anything that speaks MCP over stdio works the same way: point it at uvx streamdeck-mcp.
Linux and Headless Setups
The default profile writer targets the Elgato Stream Deck desktop app, which is available on macOS and Windows. On Linux, headless machines, or setups where you want the MCP server to own the hardware directly, use the legacy USB server:
uvx --from streamdeck-mcp streamdeck-mcp-usb
Client config shape:
{
"mcpServers": {
"streamdeck": {
"command": "uvx",
"args": ["--from", "streamdeck-mcp", "streamdeck-mcp-usb"]
}
}
}
Tools
| Tool | What it does |
|---|---|
streamdeck_find_actions | Searches configured buttons/dials across profiles and returns paste-ready native action objects for streamdeck_write_page. |
streamdeck_read_plugins | Lists installed Stream Deck plugins and declared actions from readable plugin manifests. Protected or binary manifests are reported with diagnostics instead of failing the whole catalog. |
streamdeck_read_profiles | Lists desktop profiles, device metadata, page directories, and active profile roots from ProfilesV3 or ProfilesV2. |
streamdeck_read_page | Reads a page manifest and returns simplified button details plus raw native action objects. |
streamdeck_write_page | Creates or rewrites a page manifest. Prefer action from find_actions / button.raw when reusing configured third-party plugin actions. |
streamdeck_create_icon | Generates button or touch-strip PNGs from Material Design Icons or text. Icons are bundled offline; unknown names return close-match suggestions. |
streamdeck_create_action | Creates an executable shell script in ~/StreamDeckScripts/ and returns an Open action block. |
streamdeck_restart_app | Restarts the macOS Stream Deck desktop app after profile changes. |
streamdeck_install_mcp_plugin | Installs the bundled streamdeck-mcp Stream Deck plugin used for durable encoder imagery. Usually auto-installed by streamdeck_write_page. |
Prompt support:
| Prompt | What it does |
|---|---|
design_streamdeck_deck | Gives non-skill-aware MCP clients a condensed deck-design briefing before the user describes the deck they want. |
streamdeck-designer Skill
Stream Deck MCP ships with an Agent Skill for Claude Code that teaches the agent how to plan, theme, and author full decks end to end.
Install it with:
uvx --from streamdeck-mcp streamdeck-mcp-install-skill
The skill is copied to ~/.claude/skills/streamdeck-designer/. Restart Claude Code or start a new session after installing it. Re-run with --force to upgrade after a package update.
The skill covers:
- Hardware inventory and model-specific layout planning.
- Theme palettes, typography strategy, and icon-color guidance.
- Dial and touch-strip authoring for Stream Deck + and + XL devices.
- Integration recipes for Hue, OBS, Spotify, Home Assistant, Twitch, shell commands, and browser workflows.
- Existing plugin action reuse through
streamdeck_find_actionsandstreamdeck_read_page/button.raw.
Clients that do not load Claude Code skills can invoke the design_streamdeck_deck MCP prompt instead.
Development
git clone https://github.com/verygoodplugins/streamdeck-mcp.git
cd streamdeck-mcp
uv venv && uv pip install -e ".[dev]"
uv run pytest tests/ -v
uv run ruff check .
To audit this repo against the shared Very Good Plugins MCP standards:
../mcp-ecosystem/scripts/audit-server.sh .
Authoring Notes
ProfilesV3is preferred when present.ProfilesV2is still supported, but existing pages should be targeted bydirectory_idorpage_indexbecause Elgato uses opaque directory names there.- The Elgato desktop app keeps profiles in memory and can overwrite on-disk manifest edits when it quits.
streamdeck_write_pageraisesStreamDeckAppRunningErrorwhen the app is running andauto_quit_appis not set. - On macOS, pass
auto_quit_app: trueto quit the app before writing, then callstreamdeck_restart_appwhen done. On Windows, quit and relaunch the Elgato app manually. - Set
STREAMDECK_APP_PATHif your Elgato app is not installed at/Applications/Elgato Stream Deck.app. - Generated icons live in
~/.streamdeck-mcp/generated-icons/. Generated shell scripts live in~/StreamDeckScripts/.
Legacy USB Mode
The original USB-direct server is preserved for backwards compatibility. It exposes direct hardware tools:
streamdeck_list_devices, streamdeck_connect, streamdeck_info, streamdeck_set_button, streamdeck_set_buttons, streamdeck_clear_button, streamdeck_get_button, streamdeck_clear_all, streamdeck_set_brightness, streamdeck_create_page, streamdeck_switch_page, streamdeck_list_pages, streamdeck_delete_page, streamdeck_disconnect.
When multiple decks are attached, call streamdeck_list_devices first, then pass the desired serial to streamdeck_connect. Omitting serial preserves the legacy behavior of opening the first enumerated deck.
Run it with:
uvx --from streamdeck-mcp streamdeck-mcp-usb
Support
Built by Very Good Plugins.
Related MCP servers

MCP AutoMem
Graph-vector memory for AI assistants with persistent recall across Claude, Cursor, and other MCP platforms.

Easy Digital Downloads
MCP server for Easy Digital Downloads REST API - sales, customers, products, analytics

MCP Evernote
Seamless Evernote integration for Claude with OAuth, markdown support, and note management.

MCP FreeScout
AI-powered FreeScout helpdesk ticket management with intelligent analysis, search, and draft responses.
MCP server for the VesselAPI — maritime vessel tracking, port events, emissions, and navigation data
Search Google Books and Open Library for book metadata, covers, and publication info.
