Skip to content
Back to search

obs-mcp

An MCP server for OBS

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/royshil--obs-mcp/badge.svg)](/listings/royshil--obs-mcp)

HTML

<a href="/listings/royshil--obs-mcp"><img src="/api/listings/royshil--obs-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 97 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # OBS MCP Server
  2. An MCP server for OBS Studio that provides tools to control OBS via the OBS WebSocket protocol.
  3. ## Features
  4. - Connect to OBS WebSocket server
  5. - Control OBS via MCP tools
  6. - Provides tools for:
  7. - General operations
  8. - Scene management
  9. - Source control
  10. - Scene item manipulation
  11. - Streaming and recording
  12. - Transitions
  13. ## Usage
  14. 1. Make sure OBS Studio is running with WebSocket server enabled (Tools > WebSocket Server Settings). Note the password for the WS.
  15. 2. Set the WebSocket password in environment variable (if needed):
  16. ```bash
  17. export OBS_WEBSOCKET_PASSWORD="your_password_here"
  18. ```
  19. 3. Add the MCP server to Claude desktop with the MCP server settings:
  20. ```json
  21. {
  22. "mcpServers": {
  23. "obs": {
  24. "command": "npx",
  25. "args": ["-y", "obs-mcp@latest"],
  26. "env": {
  27. "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
  28. }
  29. }
  30. }
  31. }
  32. ```
  33. 4. Use Claude to control your OBS!
  34. ## Development
  35. If you want to run the server locally using the code in this git repo, you can do the following:
  36. ```bash
  37. npm run build
  38. npm run start
  39. ```
  40. Then configure Claude desktop:
  41. ```json
  42. {
  43. "mcpServers": {
  44. "obs": {
  45. "command": "node",
  46. "args": [
  47. "<obs-mcp_root>/build/index.js"
  48. ],
  49. "env": {
  50. "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
  51. }
  52. }
  53. }
  54. }
  55. ```
  56. ## Available Tools
  57. The server provides tools organized by category:
  58. - General tools: Version info, stats, hotkeys, studio mode
  59. - Scene tools: List scenes, switch scenes, create/remove scenes
  60. - Source tools: Manage sources, settings, audio levels, mute/unmute
  61. - Scene item tools: Manage items in scenes (position, visibility, etc.)
  62. - Streaming tools: Start/stop streaming, recording, virtual camera
  63. - Transition tools: Set transitions, durations, trigger transitions
  64. ## Environment Variables
  65. - `OBS_WEBSOCKET_URL`: WebSocket URL (default: ws://localhost:4455)
  66. - `OBS_WEBSOCKET_PASSWORD`: Password for authenticating with OBS WebSocket (if required)
  67. ## Requirements
  68. - Node.js 16+
  69. - OBS Studio 31+ with WebSocket server enabled
  70. - Claude desktop
  71. ## License
  72. See the [LICENSE](LICENSE) file for details.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.