Render an Agent-visible preview
keyshot_preview_renderRender a PNG preview from an existing KeyShot scene and return it as image content. Optionally save a copy to a safe output path; temporary previews are deleted after embedding.
Instructions
Render a bounded PNG preview from an existing scene and return it directly as MCP image content. Temporary previews are deleted after embedding; an optional safe output path preserves a copy.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | Preview width in pixels. Defaults to 960; allowed range is 64 to 1920. | |
| camera | No | Optional saved camera name to activate for the preview. Omit to use the scene's active camera. | |
| height | No | Preview height in pixels. Defaults to 540; allowed range is 64 to 1080. | |
| samples | No | Preview render samples. Defaults to 16 unless maxTimeSeconds is provided; maximum is 64. | |
| scenePath | Yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. | |
| outputPath | No | Optional .png destination inside KEYSHOT_OUTPUT_DIR. Existing files are never overwritten. When omitted, a temporary preview is embedded and deleted. | |
| maxTimeSeconds | No | Time-based preview limit in seconds. Replaces the default sample mode and cannot be combined with an explicit samples value; maximum is 60. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when the requested operation completed successfully. | |
| data | No | Operation-specific structured result data, or null when unavailable. | |
| error | Yes | Human-readable failure reason, or null after success. | |
| warnings | Yes | Non-fatal conditions the user or agent should review. | |
| errorCode | No | Stable error category for common failures. | |
| outputFiles | Yes | Absolute paths of images or scene files created by the operation. | |
| suggestions | No | Actionable recovery steps for the user or agent. | |
| keyshotStdoutTail | Yes | Truncated tail of KeyShot headless output for diagnostics. |