KeyShot MCP

by truman-t3

Overview Schema Source Related Servers Discussions Admin

TypeScript

Local

Render one KeyShot view

keyshot_render

Destructive

Render the active or a named camera from an existing scene to an image file.

Instructions

Render the active or a named camera from an existing scene to an image file.

Input Schema

Name	Required	Description
`width`	No	Render width in pixels. Overrides the selected quality preset when provided.
`camera`	No	Optional saved camera name to activate before rendering. Omit to use the scene's active camera.
`format`	No	Output image format. Defaults to PNG when omitted.
`height`	No	Render height in pixels. Overrides the selected quality preset when provided.
`samples`	No	Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided.
`overwrite`	No	Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true.
`scenePath`	Yes	Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory.
`outputPath`	No	Destination image path. When omitted, a PNG name is generated inside KEYSHOT_OUTPUT_DIR.
`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

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.

Changed1 schema field changedv0.13.5Oct 22, 2026

addedInput schema / properties / overwrite

Added value: +{
+  "description": "Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true.",
+  "type": "boolean"
+}

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"
+]

Changed10 schema fields changedv0.10.0Aug 11, 2026

addedInput schema / properties / camera / description

Added value: +"Optional saved camera name to activate before rendering. Omit to use the scene's active camera."

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 / outputPath / description

Added value: +"Destination image path. When omitted, a PNG name is generated inside KEYSHOT_OUTPUT_DIR."

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

C2.9/5.0

Behavior2/5

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

Annotations already declare destructiveHint=true and non-idempotent writes, so the description should add file-safety context, but it says nothing about how output paths are resolved, that existing files require overwrite, or that a scene is opened as a side effect. It only restates that an image file is produced.

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 front-loaded sentence with no wasted words. It is efficient, though arguably under-specified for a ten-parameter destructive tool rather than genuinely complete.

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 and the parameter schema is fully documented, so the essentials for calling are present. However, for a destructive, non-idempotent render with interacting options, one sentence leaves the mutation and file-overwrite behavior entirely to the schema.

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% and the schema itself explains presets, enum formats, the samples vs maxTimeSeconds conflict, and overwrite rules. The description adds no parameter meaning beyond the schema, so the 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 specific verb (render) and resource (camera/view of a scene) plus the output (image file). It implies a single-view render, which distinguishes it softly from keyshot_render_all_cameras and keyshot_batch_render, but it never names those siblings explicitly.

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

Usage Guidelines2/5

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

There is no guidance on when to use this instead of keyshot_preview_render, keyshot_product_render, keyshot_batch_render, or keyshot_render_queue. The agent must infer the choice purely from the name and the one-line description.

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