Streamdeck Mcp

io.github.verygoodplugins由 GitHub 账号 verygoodplugins 发布v0.1.2更新于 Oct 24, 2026

MCP server for Elgato Stream Deck control — set buttons, manage pages, wire actions

已验证STDIO仅桌面效率与工作流开发者工具

概览

AI 生成的概览

让 AI 助手在本地桌面上编写和重配真实的 Elgato Stream Deck 配置档,包括按键、图标、旋钮和脚本动作。

可以做什么
  • 读取配置档、页面和已安装插件,并搜索可复用的已配置动作
  • 创建或重写配置档页面,使用原生插件动作或生成的按键
  • 离线生成按键与触控条图标,来源为 Material Design Icons 或短文本
  • 创建可执行 shell 脚本并接到 Stream Deck 的 Open 动作上
  • 重启桌面应用,并安装随附插件以持久保存旋钮图像
  • 旧版 USB 模式:列出并连接设备、设置或清除按键、调节亮度、管理页面
适用场景
适合希望由助手为你的硬件设计或反复调整 Stream Deck 布局的场景,例如为 Slack、OBS、Home Assistant、Hue 或某个代码仓库做主题化控制面板,而不必手写插件。适用于装有 Elgato 应用的桌面用户,也适用于想要直接 USB 控制的 Linux 或无头环境。
运行要求
通过 uvx 以 stdio 在本地运行(Python 包 streamdeck-mcp)。默认配置档写入面向 macOS 或 Windows 上的 Elgato Stream Deck 桌面应用;可用 STREAMDECK_APP_PATH 指定非默认安装路径。Linux 与无头环境使用单独的 USB 入口,需要连接实体设备。未声明账号或 API 密钥。
安装前请注意
它会写入配置档文件,并在用户主目录中创建可执行 shell 脚本,还可能退出或重启 Stream Deck 桌面应用;在 Windows 上需自行退出并重新启动。优先复用已配置的插件动作,否则可能丢失 Property Inspector 中的私有设置。USB 模式可清除已连接硬件上的按键和页面。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Streamdeck Mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

[Stream Deck MCP logo]

Stream Deck MCP

Stream Deck MCP lets agents build and reconfigure real Elgato Stream Deck profiles.

Quick Start · Demo · Features · Tools · Development

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:

bash
claude mcp add streamdeck -- uvx streamdeck-mcp

Claude Desktop, Cursor, Codex, and other MCP clients can use the same command:

json
{  "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:

bash
uvx --from streamdeck-mcp streamdeck-mcp-install-skill

Demo

Product trailer generated with Remotion, showing hardware inventory, plugin discovery, configured action reuse, and a final Stream Deck + XL reveal.

Features

  • Profile-native authoring - reads and writes Elgato ProfilesV3 files directly, with ProfilesV2 fallback 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_actions scans 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_plugins so agents can find plugin and action UUIDs when synthesizing new actions.
  • Configured plugin action reuse - prefers copying existing actions via find_actions or streamdeck_read_page's button.raw so 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

[Install MCP Server]

Or paste into ~/.cursor/mcp.json:

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:

json
{  "mcpServers": {    "streamdeck": {      "command": "uvx",      "args": ["streamdeck-mcp"]    }  }}

Claude Code

bash
claude mcp add streamdeck -- uvx streamdeck-mcp

OpenAI Codex

Add to ~/.codex/config.toml:

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:

bash
uvx --from streamdeck-mcp streamdeck-mcp-usb

Client config shape:

json
{  "mcpServers": {    "streamdeck": {      "command": "uvx",      "args": ["--from", "streamdeck-mcp", "streamdeck-mcp-usb"]    }  }}

Tools

ToolWhat it does
streamdeck_find_actionsSearches configured buttons/dials across profiles and returns paste-ready native action objects for streamdeck_write_page.
streamdeck_read_pluginsLists 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_profilesLists desktop profiles, device metadata, page directories, and active profile roots from ProfilesV3 or ProfilesV2.
streamdeck_read_pageReads a page manifest and returns simplified button details plus raw native action objects.
streamdeck_write_pageCreates or rewrites a page manifest. Prefer action from find_actions / button.raw when reusing configured third-party plugin actions.
streamdeck_create_iconGenerates button or touch-strip PNGs from Material Design Icons or text. Icons are bundled offline; unknown names return close-match suggestions.
streamdeck_create_actionCreates an executable shell script in ~/StreamDeckScripts/ and returns an Open action block.
streamdeck_restart_appRestarts the macOS Stream Deck desktop app after profile changes.
streamdeck_install_mcp_pluginInstalls the bundled streamdeck-mcp Stream Deck plugin used for durable encoder imagery. Usually auto-installed by streamdeck_write_page.

Prompt support:

PromptWhat it does
design_streamdeck_deckGives 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:

bash
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_actions and streamdeck_read_page / button.raw.

Clients that do not load Claude Code skills can invoke the design_streamdeck_deck MCP prompt instead.

Development

bash
git clone https://github.com/verygoodplugins/streamdeck-mcp.gitcd streamdeck-mcpuv venv && uv pip install -e ".[dev]"uv run pytest tests/ -vuv run ruff check .

To audit this repo against the shared Very Good Plugins MCP standards:

bash
../mcp-ecosystem/scripts/audit-server.sh .

Authoring Notes

  • ProfilesV3 is preferred when present. ProfilesV2 is still supported, but existing pages should be targeted by directory_id or page_index because 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_page raises StreamDeckAppRunningError when the app is running and auto_quit_app is not set.
  • On macOS, pass auto_quit_app: true to quit the app before writing, then call streamdeck_restart_app when done. On Windows, quit and relaunch the Elgato app manually.
  • Set STREAMDECK_APP_PATH if 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:

bash
uvx --from streamdeck-mcp streamdeck-mcp-usb

Support

Built by Very Good Plugins.

来源:README.md,提交 dd3e58d

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.1.2最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分