set_canvas_resolution
Configure the base and output resolution for OBS Studio to adjust canvas dimensions and frame rate globally across all scenes in the current collection.
Instructions
Set the OBS canvas (base) and output resolution. Applies globally — affects all scenes in the current collection.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | Yes | Canvas width in pixels (e.g. 2560, 1080). | |
| height | Yes | Canvas height in pixels (e.g. 1440, 1920). | |
| fps | No | Frame rate. Defaults to 60. |
Implementation Reference
- obs-mcp-server.js:525-536 (handler)The handler implementation for the 'set_canvas_resolution' tool, which uses `obs.call("SetVideoSettings", ...)` to update OBS base and output resolution.
case "set_canvas_resolution": { const fps = args.fps ?? 60; await obs.call("SetVideoSettings", { baseWidth: args.width, baseHeight: args.height, outputWidth: args.width, outputHeight: args.height, fpsNumerator: fps, fpsDenominator: 1, }); return ok({ canvas: `${args.width}x${args.height}`, fps }); } - obs-mcp-server.js:215-228 (schema)The tool definition (schema) for 'set_canvas_resolution' within the TOOLS array.
{ name: "set_canvas_resolution", description: "Set the OBS canvas (base) and output resolution. Applies globally — affects all scenes in the current collection.", inputSchema: { type: "object", properties: { width: { type: "number", description: "Canvas width in pixels (e.g. 2560, 1080)." }, height: { type: "number", description: "Canvas height in pixels (e.g. 1440, 1920)." }, fps: { type: "number", description: "Frame rate. Defaults to 60." }, }, required: ["width", "height"], }, },