{"_id":"obs-mcp","_rev":"4-e905830846878b1b9884645862e79b75","name":"obs-mcp","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"obs-mcp","version":"1.0.0","_id":"obs-mcp@1.0.0","maintainers":[{"name":"zeke","email":"zeke@sikelianos.com"}],"bin":{"obs-mcp":"build/index.js"},"dist":{"shasum":"af742c09afb711c62dd259c3acfc65d6a1875efa","tarball":"https://registry.npmjs.org/obs-mcp/-/obs-mcp-1.0.0.tgz","fileCount":3,"integrity":"sha512-mx2C3Hp2L36PHQreGdNBJgp3cUwpoSyRPWoxlM/BVvV5IFmJMkR+hOEfGz/4FYQUmFbPKsYu+0wwd6qjD6ALBg==","signatures":[{"sig":"MEYCIQCwBFoQP5P+LheBgAaAFOHQBctViG4ukJ6Ws+A6NO3ymQIhAOxIeNWR3dMUYZKqsZ0SNOJ4poxGfR/dU1tLLZDuosKg","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":20594},"type":"module","gitHead":"23fe4045e2c46ff379fd296189a503fc1452abe2","scripts":{"build":"tsc && chmod 755 build/index.js","start":"node build/index.js"},"_npmUser":{"name":"zeke","actor":{"name":"zeke","type":"user","email":"zeke@sikelianos.com"},"email":"zeke@sikelianos.com"},"_npmVersion":"10.8.2","description":"MCP server for OBS Studio","directories":{},"_nodeVersion":"20.17.0","dependencies":{"ws":"^8.16.0","zod":"^3.22.4","crypto-js":"^4.2.0","@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"@types/ws":"^8.5.10","typescript":"^5.4.2","@types/node":"^20.11.25","@types/crypto-js":"^4.2.2"},"_npmOperationalInternal":{"tmp":"tmp/obs-mcp_1.0.0_1751500521125_0.8261827098377752","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"obs-mcp","version":"1.0.1","_id":"obs-mcp@1.0.1","maintainers":[{"name":"zeke","email":"zeke@sikelianos.com"}],"bin":{"obs-mcp":"build/index.js"},"dist":{"shasum":"9a65d2bbfaf5f2a650e42dcd022d6fb6722abe66","tarball":"https://registry.npmjs.org/obs-mcp/-/obs-mcp-1.0.1.tgz","fileCount":21,"integrity":"sha512-CRAE46oAeF1XBovYvER/cv3QMEQatKx8IJXy0JrjjCuAZTHGRYDPVvjCt47rtnHeawxLHFiyagKy2J0uiscw2A==","signatures":[{"sig":"MEUCIQDE7HBcuIkKOH9AbexOTO7USS+GwLRdeDHDuT69RGUALAIgbCih0bQ+lc3IpWNtw5Apk0EFAd0NYlQVpRBqd5jUv50=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":166700},"main":"build/index.js","type":"module","gitHead":"25675f3cfc3e68949c217b8d306cb5341bf9f46a","scripts":{"test":"vitest run","build":"tsc && chmod 755 build/index.js","start":"node build/index.js"},"_npmUser":{"name":"zeke","actor":{"name":"zeke","type":"user","email":"zeke@sikelianos.com"},"email":"zeke@sikelianos.com"},"_npmVersion":"10.8.2","description":"MCP server for OBS Studio","directories":{},"_nodeVersion":"20.17.0","dependencies":{"ws":"^8.16.0","zod":"^3.22.4","crypto-js":"^4.2.0","@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"1.6.1","@types/ws":"^8.5.10","typescript":"^5.4.2","@types/node":"^20.11.25","@types/crypto-js":"^4.2.2"},"_npmOperationalInternal":{"tmp":"tmp/obs-mcp_1.0.1_1751500854871_0.4174633317542906","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"obs-mcp","version":"1.1.0","description":"MCP server for OBS Studio","type":"module","bin":{"obs-mcp":"build/index.js"},"main":"build/index.js","scripts":{"build":"tsc && chmod 755 build/index.js","start":"node build/index.js","test":"vitest run"},"dependencies":{"@modelcontextprotocol/sdk":"^1.0.0","crypto-js":"^4.2.0","ws":"^8.16.0","zod":"^3.22.4"},"devDependencies":{"@types/crypto-js":"^4.2.2","@types/node":"^20.11.25","@types/ws":"^8.5.10","typescript":"^5.4.2","vitest":"1.6.1"},"_id":"obs-mcp@1.1.0","gitHead":"373989b5b15ec61fb03567e5bc1ad489228628a4","_nodeVersion":"22.17.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-IrB9DjUdPvvpix2eo1b0kbYG8jOEb64LhUKitKVzR8aXdtF2U88PWS62a8vQymIKCDjLyYqyHVpIUcPxMJWrsA==","shasum":"04bc7b4fb43cfacc6ecc84f9969b23e322c8a6dd","tarball":"https://registry.npmjs.org/obs-mcp/-/obs-mcp-1.1.0.tgz","fileCount":21,"unpackedSize":166929,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIGoLcF6BS0yjMHtT6870fGMuDkpkdeODWGGXeWYoCU8NAiBmSFLzGEHozFnnYSUXm+ytadbXhmtseddmWj5H7ynYRA=="}]},"_npmUser":{"name":"zeke","email":"zeke@sikelianos.com"},"directories":{},"maintainers":[{"name":"zeke","email":"zeke@sikelianos.com"},{"name":"royshilkrot","email":"roy.shil@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/obs-mcp_1.1.0_1756228986809_0.6543012117102154"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-02T23:55:21.124Z","modified":"2025-08-26T17:23:07.201Z","1.0.0":"2025-07-02T23:55:21.302Z","1.0.1":"2025-07-03T00:00:55.047Z","1.1.0":"2025-08-26T17:23:07.021Z"},"description":"MCP server for OBS Studio","maintainers":[{"name":"zeke","email":"zeke@sikelianos.com"},{"name":"royshilkrot","email":"roy.shil@gmail.com"}],"readme":"# OBS MCP Server\n\nAn MCP server for OBS Studio that provides tools to control OBS via the OBS WebSocket protocol.\n\n## Features\n\n- Connect to OBS WebSocket server\n- Control OBS via MCP tools\n- Provides tools for:\n  - General operations\n  - Scene management\n  - Source control\n  - Scene item manipulation\n  - Streaming and recording\n  - Transitions\n\n\n## Usage\n\n1. Make sure OBS Studio is running with WebSocket server enabled (Tools > WebSocket Server Settings). Note the password for the WS.\n2. Set the WebSocket password in environment variable (if needed):\n\n```bash\nexport OBS_WEBSOCKET_PASSWORD=\"your_password_here\"\n```\n\n3. Add the MCP server to Claude desktop with the MCP server settings:\n\n```json\n{\n  \"mcpServers\": {\n    \"obs\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"obs-mcp@latest\"],\n      \"env\": {\n        \"OBS_WEBSOCKET_PASSWORD\": \"<password_from_obs>\"\n      }\n    }\n  }\n}\n```\n\n4. Use Claude to control your OBS!\n\n## Development\n\nIf you want to run the server locally using the code in this git repo, you can do the following:\n\n\n```bash\nnpm run build\nnpm run start\n```\n\nThen configure Claude desktop:\n\n```json\n{\n  \"mcpServers\": {\n    \"obs\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"<obs-mcp_root>/build/index.js\"\n      ],\n      \"env\": {\n        \"OBS_WEBSOCKET_PASSWORD\": \"<password_from_obs>\"\n      }\n    }\n  }\n}\n```\n\n## Available Tools\n\nThe server provides tools organized by category:\n\n- General tools: Version info, stats, hotkeys, studio mode\n- Scene tools: List scenes, switch scenes, create/remove scenes\n- Source tools: Manage sources, settings, audio levels, mute/unmute\n- Scene item tools: Manage items in scenes (position, visibility, etc.)\n- Streaming tools: Start/stop streaming, recording, virtual camera\n- Transition tools: Set transitions, durations, trigger transitions\n\n## Environment Variables\n\n- `OBS_WEBSOCKET_URL`: WebSocket URL (default: ws://localhost:4455)\n- `OBS_WEBSOCKET_PASSWORD`: Password for authenticating with OBS WebSocket (if required)\n\n## Requirements\n\n- Node.js 16+\n- OBS Studio 31+ with WebSocket server enabled\n- Claude desktop\n\n## License\n\nSee the [LICENSE](LICENSE) file for details.","readmeFilename":"README.md"}