KeyShot MCP

Overview Schema Source Related Servers Discussions Admin

Render selected cameras

keyshot_batch_render

Destructive

Render a chosen list of saved cameras from a KeyShot scene into an output directory, enabling batch image generation with per-render format, size, and quality controls.

Instructions

Render an explicit list of saved cameras from one scene into an output directory.

Input Schema

TableJSON Schema

Name	Required	Description
`width`	No	Render width in pixels. Overrides the selected quality preset when provided.
`format`	No	Output image format. Defaults to PNG when omitted.
`height`	No	Render height in pixels. Overrides the selected quality preset when provided.
`cameras`	Yes	Saved camera names to render in order. Use keyshot_list_cameras first when names are unknown.
`samples`	No	Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided.
`outputDir`	Yes	Directory for generated render files. Relative paths resolve inside KEYSHOT_OUTPUT_DIR; external paths are rejected by default.
`overwrite`	No	Whether existing image files may be replaced. Defaults to false.
`scenePath`	Yes	Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory.
`qualityPreset`	No	Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples).
`maxTimeSeconds`	No	Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples.

Output Schema

TableJSON Schema

Name	Required	Description
`ok`	Yes	True when the requested operation completed successfully.
`data`	Yes	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.

Schema Changelog

Changes observed during successful MCP inspections.

Changed7 schema fields changedv0.13.0Sep 30, 2026

changedInput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / height / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / samples / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / width / maximum
```
Added value: +9007199254740991
```

changedOutput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

changedOutput schema / required

Previous value: -[
-  "ok",
-  "outputFiles",
-  "warnings",
-  "keyshotStdoutTail",
-  "error"
-]New value: +[
+  "ok",
+  "data",
+  "outputFiles",
+  "warnings",
+  "keyshotStdoutTail",
+  "error"
+]

Changed11 schema fields changedv0.10.0Aug 11, 2026

addedInput schema / properties / cameras / description

Added value: +"Saved camera names to render in order. Use keyshot_list_cameras first when names are unknown."

addedInput schema / properties / format / description

Added value: +"Output image format. Defaults to PNG when omitted."

addedInput schema / properties / height / description

Added value: +"Render height in pixels. Overrides the selected quality preset when provided."

addedInput schema / properties / maxTimeSeconds / description

Added value: +"Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples."

addedInput schema / properties / outputDir / description

Added value: +"Directory for generated render files. Relative paths resolve inside KEYSHOT_OUTPUT_DIR; external paths are rejected by default."

addedInput schema / properties / overwrite / description

Added value: +"Whether existing image files may be replaced. Defaults to false."

addedInput schema / properties / qualityPreset

Added value: +{
+  "description": "Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples).",
+  "enum": [
+    "preview",
+    "standard",
+    "final"
+  ],
+  "type": "string"
+}

addedInput schema / properties / samples / description

Added value: +"Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided."

addedInput schema / properties / scenePath / description

Added value: +"Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory."

addedInput schema / properties / width / description

Added value: +"Render width in pixels. Overrides the selected quality preset when provided."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "data": {
+      "anyOf": [
+        {},
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Operation-specific structured result data, or null when unavailable."
+    },
+    "error": {
+      "description": "Human-readable failure reason, or null after success.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "errorCode": {
+      "description": "Stable error category for common failures.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "keyshotStdoutTail": {
+      "description": "Truncated tail of KeyShot headless output for diagnostics.",
+      "type": "string"
+    },
+    "ok": {
+      "description": "True when the requested operation completed successfully.",
+      "type": "boolean"
+    },
+    "outputFiles": {
+      "description": "Absolute paths of images or scene files created by the operation.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "suggestions": {
+      "description": "Actionable recovery steps for the user or agent.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "warnings": {
+      "description": "Non-fatal conditions the user or agent should review.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "ok",
+    "outputFiles",
+    "warnings",
+    "keyshotStdoutTail",
+    "error"
+  ],
+  "type": "object"
+}

First observedv0.2.1Jul 9, 2026

TDQS

B3.2/5.0

Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already flag destructiveHint=true, non-idempotent, non-read-only, so the description should explain *how* it's destructive (overwriting existing files). It only implies writing into a directory and never mentions overwrite behavior, side effects, or that it is a heavy/long operation, adding little beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single efficient sentence front-loads the verb and output. It is appropriately short, though slightly thin given the tool's complexity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return values needn't be explained, and the schema covers parameters fully. However, for a destructive batch render tool with many configurable options, the description omits overwrite/destructive behavior and alternative-tool routing, leaving notable gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all 10 parameters (cameras, outputDir, qualityPreset, samples, maxTimeSeconds, etc.) are fully documented in the schema. The description adds no parameter semantics beyond what the schema provides, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a clear verb (render) and resource (explicit list of saved cameras) plus the destination (output directory). It distinguishes itself somewhat from siblings like keyshot_render_all_cameras (all vs. explicit list), though it does not name that distinction explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The word 'explicit list' implies you must already know camera names, and the schema notes to call keyshot_list_cameras first. But the description itself gives no when-to-use vs. keyshot_render_all_cameras or keyshot_render guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.