docs: Lead README with use cases and multi-client install#37
Merged
jack-arturo merged 3 commits intomainfrom Apr 28, 2026
Merged
docs: Lead README with use cases and multi-client install#37jack-arturo merged 3 commits intomainfrom
jack-arturo merged 3 commits intomainfrom
Conversation
Include a new screenshot and example for the streamdeck-designer Agent Skill: adds docs/screenshots/slack-control-board.jpg and embeds it in README.md with an explanatory caption. Also expands the README examples to mention a "Slack control board" prompt to illustrate one-shot deck generation (channel jumps, status toggles, unread dials) using the MCP tools.
Reframes the README around what people can actually build instead of the server's architecture. Leads with five grounded example prompts (Slack, Home Assistant, OBS, dev decks, cross-MCP orchestration) that emphasize the discovery-via-other-MCPs pattern and the dynamic icon generation. Adds per-client install snippets for Cursor (with one-click deeplink), Claude Desktop, Claude Code, and OpenAI Codex, plus a generic stdio note. Demotes the legacy USB-direct server to a single section near the bottom with a Linux-user heads-up. Existing technical content (tools table, editing workflow, plugin internals) is preserved. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project’s README to lead with concrete Stream Deck use cases and provide clearer MCP client installation instructions, while keeping the existing technical/reference sections and moving legacy USB mode down the page.
Changes:
- Reframes README introduction around example decks and adds a hero screenshot + caption.
- Adds a multi-client install guide (Cursor deeplink + config snippets for Cursor, Claude Desktop/Code, Codex, and generic stdio).
- Reorganizes existing technical sections (skill, tools, editing workflow, legacy USB mode, development).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Re-add icon/text mutual-exclusivity note to streamdeck_create_icon row - Mark streamdeck_restart_app as macOS-only (raises elsewhere) - Add Platform support note to Editing workflow explaining macOS-only behavior of running-app guard, auto_quit_app, and restart_app, and what Windows users need to do manually Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cursor://deeplink button), Claude Desktop, Claude Code (claude mcp add ... -- uvx streamdeck-mcp), OpenAI Codex (~/.codex/config.toml), plus a generic stdio note. Linux users are pointed at the legacy USB server.uvx --frominvocation. Useful when you'd rather have the MCP server own the hardware directly (Linux, headless setups, or environments where the Elgato app isn't running).Test plan
{"command":"uvx","args":["streamdeck-mcp"]}).claude_desktop_config.jsonon a clean install and confirm the server starts.claude mcp add streamdeck -- uvx streamdeck-mcpin a fresh Claude Code project and confirm tools enumerate.[mcp_servers.streamdeck]block to~/.codex/config.tomland confirm Codex sees the server.uvx --from streamdeck-mcp streamdeck-mcp-install-skillstill copies the skill to~/.claude/skills/streamdeck-designer/.uvx --from streamdeck-mcp streamdeck-mcp-usbentrypoint still launches the USB-direct server.🤖 Generated with Claude Code