dcc-mcp-obs

Control nativo y tipado de OBS Studio para el ecosistema DCC-MCP.

Este producto es un plugin de OBS y un sidecar de DCC-MCP. El plugin en C++ se ejecuta dentro del proceso exacto de OBS, gestiona el ciclo de vida del host y el despacho en el hilo de la UI, y registra solicitudes de proveedor acotadas a través de la API oficial de OBS WebSocket 5.x. El sidecar de Python expone esos contratos a través de MCP, el Gateway, una CLI de Install SOP v1 y una skill de Agent incluida.

OBS WebSocket es el transporte autenticado. No se utiliza como una vía de escape sin restricciones para solicitudes, y este producto no expone ningún script arbitrario ni herramienta WebSocket en bruto.

Primera entrega

• Plugin nativo exacto, versión de OBS, PID, ID de instancia, disponibilidad y secuencia de eventos

• Descubrimiento de escenas acotado y lectura de la escena actual

• Descubrimiento de fuentes acotado para la escena actual o una escena exacta con nombre

• Estado de grabación

• Iniciar, detener, pausar y reanudar la grabación

• Una lectura de estado tipada independiente después de cada mutación

• Errores redactados estables, despacho de UI acotado y rechazo de desviación de la instancia exacta

La matriz de capacidades legible por máquina hace seguimiento de los dominios restantes del producto. No se representan intencionadamente como herramientas publicadas hasta que sus contratos tipados se materialicen.

Related MCP server: obs-mcp-server

Hoja de ruta de control total

• Streaming, búfer de repetición, cámara virtual y salidas

• Perfiles, colecciones de escenas, atajos de teclado acotados, capturas de pantalla y estado del operador

• Aceptación desechable con OBS real

• Entradas, propiedades, filtros, audio y medios

• Grafo de escenas, conmutación, transiciones y Modo Studio

Requisitos

• OBS Studio 28 o superior con OBS WebSocket 5.x habilitado

• Python 3.10 o superior

• dcc-mcp-core>=0.20.14,<1.0.0

• El paquete de plugin nativo correspondiente para Windows, macOS o Linux

Instalación

Instala el plano de control de Python y, a continuación, instala un paquete de plugin nativo de la versión cuyo digest SHA-256 hayas obtenido de la misma versión:

python -m pip install dcc-mcp-obs
dcc-mcp-obs-install install \
  --plugin-archive dcc-mcp-obs-plugin.zip \
  --sha256 <release-sha256>
dcc-mcp-obs-install verify

El instalador emite un objeto JSON de Install SOP v1. --dry-run realiza la verificación previa del paquete y de la propiedad sin modificar el directorio de plugins de OBS. Consulta detalles de instalación.

Contraseña y endpoint

Configura la contraseña de OBS WebSocket en el entorno propiedad del operador:

set DCC_MCP_OBS_WEBSOCKET_PASSWORD=your-password

La primera versión acepta únicamente ws://127.0.0.1:<port> y por defecto usa el puerto 4455. Una contraseña nunca se devuelve en resultados de herramientas, recibos, errores públicos ni registros. Usa DCC_MCP_OBS_WEBSOCKET_URL solo para seleccionar otro puerto de bucle local.

Ejecuta el sidecar contra un proceso exacto de OBS:

dcc-mcp-obs --host-pid <obs-pid>

Descubrimiento de agentes

La skill obs-control incluida proporciona alias de descubrimiento en inglés y chino para OBS, Open Broadcaster Software, recording, scene/source inspection, pause, resume, 录屏 y 录制视频. Los agentes buscan y cargan la skill antes de llamar a las ocho herramientas exactas de esta primera entrega. El streaming y la conmutación de escenas siguen siendo capacidades de la hoja de ruta, no controles nativos incluidos.

El control de OBS prioriza el plugin nativo/WebSocket. Las acciones exclusivamente visuales no compatibles pueden usar DCC-MCP ui-control con DCC-CUA propiedad del proyecto únicamente después de un enlace exacto de PID y HWND, una instantánea reciente y una lectura posterior a la acción. No existe un respaldo genérico de Computer Use.

Desarrollo

python -m pip install -e ".[dev]"
python -m pytest
python -m ruff check .
python -m ruff format --check .
dcc-mcp-cli lint src/dcc_mcp_obs/skills/obs-control --warnings-as-errors

La compilación nativa utiliza la cadena de herramientas oficial de la plantilla de plugins de OBS y las entradas del SDK de OBS 31.1.1 fijadas con hashes SHA-256:

cmake --preset windows-x64
cmake --build --preset windows-ci-x64

Las compilaciones de CI equivalentes se ejecutan en Windows, macOS y Linux.

Límite de validación

Las pruebas unitarias, las sesiones de protocolo simuladas, la compilación nativa, las pruebas de humo del paquete y la CI no demuestran un host de OBS con licencia/en vivo. Esta entrega inicial no hace ninguna afirmación de aceptación con OBS real. Un issue de aceptación con host en vivo desechable sigue siendo una puerta de lanzamiento independiente.

Licencia

GPL-2.0-or-later. El módulo nativo enlaza con OBS Studio e incluye el encabezado oficial de la API del plugin OBS WebSocket con su aviso original.