save_screenshot
Capture the current OBS Studio output as an image file in PNG, JPG, or BMP format at a specified file path.
Instructions
Save a screenshot of the current OBS output to a file.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes | Absolute path where the screenshot should be saved (e.g. /tmp/obs-shot.png). | |
| image_format | No | Image format: png, jpg, bmp. Defaults to png. |
Implementation Reference
- obs-mcp-server.js:515-522 (handler)Handler implementation for the save_screenshot tool. It uses obs-websocket's SaveSourceScreenshot command to capture the current scene.
case "save_screenshot": { await obs.call("SaveSourceScreenshot", { sourceName: (await obs.call("GetSceneList")).currentProgramSceneName, imageFormat: args.image_format ?? "png", imageFilePath: args.file_path, }); return ok({ saved_to: args.file_path }); } - obs-mcp-server.js:195-212 (schema)Tool definition and input schema for save_screenshot.
name: "save_screenshot", description: "Save a screenshot of the current OBS output to a file.", inputSchema: { type: "object", properties: { file_path: { type: "string", description: "Absolute path where the screenshot should be saved (e.g. /tmp/obs-shot.png).", }, image_format: { type: "string", description: "Image format: png, jpg, bmp. Defaults to png.", }, }, required: ["file_path"], }, },