obs-mcp 0.2.0__tar.gz

obs_mcp-0.2.0/.gitattributes

@@ -0,0 +1,30 @@
+# Enforce LF line endings on files that must work as Unix scripts.
+# Without this, git on Windows can convert them to CRLF on checkout and
+# break `bash install.sh` on macOS/Linux with a cryptic "command not found"
+# or "bad interpreter: /bin/bash^M" error.
+
+# Shell scripts — always LF
+*.sh text eol=lf
+
+# Python — always LF
+*.py text eol=lf
+
+# Config files that get read by shell tools
+.gitignore text eol=lf
+.gitattributes text eol=lf
+
+# Markdown + JSON — accept either, default to LF for consistency
+*.md text eol=lf
+*.json text eol=lf
+*.toml text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+
+# Windows-only batch — always CRLF
+*.bat text eol=crlf
+*.cmd text eol=crlf
+
+# Binary formats — never touch
+*.png binary
+*.jpg binary
+*.ico binary

obs_mcp-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish to PyPI
+
+# Fires automatically on every version tag push (git tag vX.Y.Z && git push
+# --tags) — no manual `twine upload` step, and no PyPI token stored anywhere
+# in this repo. Uses PyPI's Trusted Publisher (OIDC) mechanism instead: PyPI
+# is configured (once, on pypi.org) to trust this exact workflow in this
+# exact repo, so GitHub can prove its identity to PyPI without a shared
+# secret to store, rotate, or leak.
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:  # lets this be re-run manually from the Actions tab or `gh workflow run`
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install --upgrade build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # required for Trusted Publishing — do not remove
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

obs_mcp-0.2.0/.gitignore

@@ -0,0 +1,32 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environments
+venv/
+.venv/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Claude
+.claude/
+.mcp.json

obs_mcp-0.2.0/CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+All notable changes to OBS-MCP will be documented in this file.
+
+## [Unreleased]
+
+## [0.2.0] - 2026-07-26
+
+### Added
+
+- **One-click installers (`install.sh` / `install.bat`).** Check for Python
+  (offer to install it if missing), install `obs-mcp`, verify the installed
+  `obs-mcp` command actually resolves to the Python just used (catches
+  stale/shadowed installs on machines with multiple Pythons), and
+  optionally write the config for Claude Desktop and/or LM Studio
+  automatically — no manual JSON editing required for a first-time setup.
+  Both scripts were actually executed end-to-end during development, not
+  just written — `install.bat` initially failed on non-ASCII characters in
+  its comment headers under `cmd.exe`'s default codepage, caught by running
+  it rather than assuming Windows batch syntax was fine.
+- **`diagnose_av_health` pipeline tool.** Pulls `GetStats` + `GetStreamStatus`
+  + `GetRecordStatus` in one call and interprets the render-skip/output-skip/
+  congestion ratios instead of returning raw numbers — distinguishes a GPU/
+  scene bottleneck (high render-thread skips) from an encoder bottleneck
+  (high output-thread skips, low congestion) from a network bottleneck (high
+  congestion), and flags low disk space before it silently kills a
+  recording. 148 tools total now.
+
+### Fixed
+
+- **Concurrent tool calls could corrupt results.** `obsws-python`'s request
+  layer does a bare send-then-recv with no request-ID matching, so two
+  overlapping calls could each read the other's response off the socket.
+  `OBSClient.execute()` now serializes every call (connect included) through
+  one lock.
+- **The OBS WebSocket password was logged in plaintext.** `obsws-python`
+  logs `"Connecting with parameters: ... password='...'"` at `INFO` on every
+  connect; with our own logger also at `INFO`, that line reached stderr (and
+  whatever log file the MCP client persists it to). `obsws_python`'s logger
+  is now capped at `WARNING`.
+- **An ordinary OBS-side error (bad scene name, out-of-range value) forced a
+  full reconnect on the next call**, identically to an actual dropped
+  connection — even though the socket was still healthy. Only a real
+  connection failure resets the client now.
+- **`clean_audio_input` could append the Noise Gate after a pre-existing
+  Compressor/Suppression filter**, inverting the gate-first ordering the
+  whole tool exists to guarantee. It now anchors its three managed stages
+  as an adjacent, correctly-ordered group regardless of what already
+  existed on the input.
+
+## [0.1.0] - 2026-07-17
+
+### Added
+
+- **Initial release — 147 tools covering the full obs-websocket v5 protocol.**
+  Verified live against a real OBS Studio instance — scene/audio-mixer
+  control, filter chains, video/output settings, and screenshots all
+  confirmed working end-to-end, in addition to every tool mapping to a
+  verified obs-websocket request (field names and types checked against the
+  official protocol spec, not guessed).
+  - **General** (9 tools): version/stats, hotkeys, custom events, vendor
+    requests, persistent data.
+  - **Config** (15 tools): scene collections, profiles, video/canvas
+    settings, stream service destination, record directory.
+  - **Sources** (3 tools): active-state check and screenshots.
+  - **Scenes** (12 tools): list/create/remove/rename, program/preview
+    control, per-scene transition overrides, canvases, groups.
+  - **Inputs & Audio** (28 tools): the full mixer surface — mute, volume,
+    balance, sync offset, monitor type, audio track routing, deinterlace
+    mode/field order, dynamic property lists (e.g. display-capture's
+    monitor list), properties-dialog button presses.
+  - **Transitions** (9 tools): list/set, duration, settings, T-bar
+    scrubbing, trigger (including studio mode).
+  - **Filters** (10 tools): full CRUD on source filter chains, any order.
+  - **Scene Items** (17 tools): transform, enabled/locked, z-order index,
+    blend mode, source lookup, duplication.
+  - **Outputs** (17 tools): virtual camera, replay buffer, generic named
+    outputs.
+  - **Stream & Record** (14 tools): start/stop/toggle, captions,
+    pause/resume, file splitting, chapter markers.
+  - **Media** (4 tools): playback status, seek, transport actions.
+  - **UI** (8 tools): studio mode, property/filter/interact dialogs,
+    monitor list, projectors.
+  - **Pipelines** (1 tool): `clean_audio_input` — one-call Noise Gate →
+    Noise Suppression → Compressor chain, with filter setting keys verified
+    against OBS Studio's actual C source
+    (`plugins/obs-filters/{noise-gate,noise-suppress,compressor}-filter.c`),
+    not guessed from the UI. Picks `noise_suppress_filter_v2` (RNNoise) vs
+    the older `noise_suppress_filter` based on what the connected OBS build
+    actually registers, instead of assuming.
+  - `tool_registry.py` ships with the fail-loud `_EXPECTED_MODULES` check
+    from day one (a lesson learned the hard way on a sibling project —
+    Reaper-MCP shipped for months with four tool modules silently excluded
+    by an overbroad `.gitignore` rule; this project's registry refuses to
+    stay quiet about a module going missing, for every profile, from the
+    start).

obs_mcp-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contributing to OBS-MCP
+
+Thanks for your interest in contributing! Every PR — tool, bug fix, doc, or test — is welcome.
+
+## Development setup
+
+```bash
+git clone https://github.com/xDarkzx/OBS_MCP.git
+cd OBS_MCP
+pip install -e ".[dev]"
+```
+
+This installs `obs-mcp` in editable mode along with `pytest` / `pytest-asyncio` for tests.
+
+## Running tests
+
+```bash
+pytest tests/ -x -q
+```
+
+All tests must pass before submitting a PR.
+
+## Adding a new tool
+
+1. Pick the right module in `obs_mcp/tools/` — or create a new `*_tools.py` file. The tool registry auto-discovers any module that defines `register(mcp)`; helper files without that function are silently skipped.
+2. Inside `register(mcp)`, define your tool with the `@mcp.tool()` decorator.
+3. Validate required inputs (missing-parameter checks, range-check anything obs-websocket documents a numeric range for) before dispatching.
+4. Dispatch via `client.execute("RequestType", **params)` — the exact `RequestType` string and field names come from the [obs-websocket v5 protocol spec](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md). Verify field names against that spec (or the actual OBS source for filter/plugin settings) — don't guess.
+5. If you're adding a new module, add its name to `_EXPECTED_MODULES` in `tool_registry.py`.
+6. Add tests in `tests/`.
+
+Example:
+
+```python
+from mcp.server.fastmcp import FastMCP
+
+from obs_mcp.error_codes import ErrorCode, OBSMCPError
+
+def register(mcp: FastMCP):
+    from obs_mcp.main import client
+
+    @mcp.tool()
+    async def my_tool(scene_name: str) -> dict:
+        """Short description of what this tool does.
+
+        Args:
+            scene_name: What this parameter controls.
+        """
+        if not scene_name:
+            raise OBSMCPError(ErrorCode.MISSING_PARAMETER, "scene_name is required")
+        return await client.execute("MyRequestType", sceneName=scene_name)
+```
+
+See `obs_mcp/tools/scene_tools.py` for a straightforward reference implementation.
+
+## Adding a new pipeline tool
+
+Pipeline tools (`pipeline_tools.py`) compose several raw requests into one call that
+does what the user actually wants, instead of making the AI hand-assemble the
+mechanism. If you're adding one:
+
+1. Verify every setting field name against the actual OBS Studio source
+   (`plugins/obs-filters/*.c` for filter settings) — the UI labels in OBS's
+   own dialogs don't always match the underlying JSON keys.
+2. Query what's actually available (e.g. `GetSourceFilterKindList`) rather than
+   assuming a filter kind is registered — it varies by platform and OBS build.
+3. Skip stages that already exist instead of duplicating them.
+
+## Code style
+
+- Python 3.10+ (type hints on public surfaces).
+- No comments or docstrings on obvious code — well-named identifiers are enough.
+- Keep input validation explicit; error handling should mention the specific bad value.
+
+## Security
+
+- Validate every parameter before dispatch.
+- Never commit API keys, OBS WebSocket passwords, or credentials. Secrets go in environment variables, not source.
+
+## Pull requests
+
+- Keep PRs focused on a single change.
+- Include tests for new tools.
+- Describe what your change does and why.
+- Update `CHANGELOG.md` under the current unreleased section.
+
+## Reporting issues
+
+Open an issue on GitHub with:
+
+- What you expected to happen.
+- What actually happened.
+- Steps to reproduce.
+- Your OS, Python version, and OBS Studio version.
+- Relevant stderr output from the MCP server (the `[obs-mcp]` banner lines).

obs_mcp-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 xDarkzx
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.