KeyShot MCP

Overview Schema Source Related Servers Discussions Admin

Run a sequential render queue

keyshot_render_queue

Destructive

Render multiple KeyShot scenes and cameras one after another to prevent license and output file conflicts. Submit a list of jobs with per-job settings; optionally continue after failures.

Instructions

Render independent scene and camera jobs sequentially so KeyShot processes do not compete for a license or output files.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`jobs`	Yes	Render jobs executed sequentially to avoid KeyShot license and output conflicts.
`continueOnError`	No	Continue with later jobs after a failure. Defaults to false.

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.

Changed8 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
```
removedInput schema / properties / jobs / items / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / jobs / items / properties / height / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / jobs / items / properties / samples / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / jobs / items / 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"
+]

Changed12 schema fields changedv0.10.0Aug 11, 2026

addedInput schema / properties / continueOnError / description

Added value: +"Continue with later jobs after a failure. Defaults to false."

addedInput schema / properties / jobs / description

Added value: +"Render jobs executed sequentially to avoid KeyShot license and output conflicts."

addedInput schema / properties / jobs / items / properties / camera / description

Added value: +"Optional saved camera name for this job. Omit to use the active camera."

addedInput schema / properties / jobs / items / properties / format / description
```
Added value: +"Output image format. Defaults to PNG when omitted."
```

addedInput schema / properties / jobs / items / properties / height / description

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

addedInput schema / properties / jobs / items / properties / maxTimeSeconds / description

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

addedInput schema / properties / jobs / items / properties / outputPath / description

Added value: +"Destination image path for this queue job. A safe output name is generated when omitted."

addedInput schema / properties / jobs / items / 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 / jobs / items / properties / samples / description

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

addedInput schema / properties / jobs / items / 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 / jobs / items / 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"
+}

Addedv0.4.0Jul 9, 2026

TDQS

A3.5/5.0

Behavior3/5

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

Annotations already declare destructiveHint=true, non-idempotent, non-read-only, so the safety profile is carried by structured data. The description adds genuinely useful context (serial execution to avoid license/output contention) but says nothing about what destruction actually means here — e.g. whether existing files at outputPath are overwritten, or that failure stops the queue by default.

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

Conciseness5/5

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

A single front-loaded sentence with no filler; the operative behavior (sequential execution) and its reason are both delivered immediately.

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?

An output schema exists, so return values need not be explained. However, for a destructive, non-idempotent queue tool whose key semantics (overwriting outputs, default stop-on-error, ordering guarantees) live only in schema defaults, the description is thinner than the complexity warrants.

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 the schema already documents scenePath, outputPath, camera, qualityPreset, samples/maxTimeSeconds exclusivity, etc. The description adds no parameter-level detail, which is the expected baseline when the schema does the heavy lifting.

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 specific verb and resource ('Render ... jobs'), and the adverb 'sequentially' plus 'independent scene and camera jobs' distinguishes it from a single-render tool. It does not name the close siblings (keyshot_batch_render, keyshot_render_all_cameras) it most resembles, so the distinction is implicit rather than explicit.

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 rationale 'so KeyShot processes do not compete for a license or output files' implies when to choose this over firing off parallel renders, but no explicit when-to-use or when-not-to-use guidance against the sibling render tools is given.

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