KeyShot MCP

by truman-t3

Overview Schema Source Related Servers Discussions Admin

TypeScript

Local

Import a model into KeyShot

keyshot_import_model

Destructive

Import a supported local model into an empty or base scene, apply requested composition options, and save a new scene.

Instructions

Import a supported local model into an empty or base scene, apply requested composition options, and save a new scene.

Input Schema

Name	Required	Description
`modelPath`	Yes	Absolute path to a model file supported by KeyShot, such as OBJ, FBX, STL, or glTF.
`overwrite`	No	Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true.
`snapToGround`	No	Ask KeyShot to place imported geometry on the ground plane when supported.
`baseScenePath`	No	Optional existing KeyShot scene to use as the import base. Omit to start from an empty scene.
`centerGeometry`	No	Ask KeyShot to center imported geometry during import when supported.
`outputScenePath`	Yes	Destination path for a saved scene copy, never an input file. Existing files are rejected unless overwrite=true. Must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled.
`adjustEnvironment`	No	Ask KeyShot to adjust the environment to the imported geometry when supported.
`adjustCameraLookAt`	No	Ask KeyShot to retarget the active camera to the imported geometry when supported.

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.

Changed2 schema fields changedv0.13.5Oct 22, 2026

changedInput schema / properties / outputScenePath / description

Previous value: -"Destination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled."New value: +"Destination path for a saved scene copy, never an input file. Existing files are rejected unless overwrite=true. Must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled."

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

Changed4 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
```

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

Changed8 schema fields changedv0.10.0Aug 11, 2026

addedInput schema / properties / adjustCameraLookAt

Added value: +{
+  "description": "Ask KeyShot to retarget the active camera to the imported geometry when supported.",
+  "type": "boolean"
+}

addedInput schema / properties / adjustEnvironment

Added value: +{
+  "description": "Ask KeyShot to adjust the environment to the imported geometry when supported.",
+  "type": "boolean"
+}

addedInput schema / properties / baseScenePath / description

Added value: +"Optional existing KeyShot scene to use as the import base. Omit to start from an empty scene."

addedInput schema / properties / centerGeometry

Added value: +{
+  "description": "Ask KeyShot to center imported geometry during import when supported.",
+  "type": "boolean"
+}

addedInput schema / properties / modelPath / description

Added value: +"Absolute path to a model file supported by KeyShot, such as OBJ, FBX, STL, or glTF."

addedInput schema / properties / outputScenePath / description

Added value: +"Destination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled."

addedInput schema / properties / snapToGround

Added value: +{
+  "description": "Ask KeyShot to place imported geometry on the ground plane when supported.",
+  "type": "boolean"
+}

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

A3.6/5.0

Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and readOnlyHint=false; the description adds that a new scene is written, reinforcing the write outcome. However, it does not warn about overwriting an existing output file or about the KEYSHOT_OUTPUT_DIR containment rule, both of which affect whether a call is safe. The description does not contradict the annotations, but it adds only modest context to a destructive operation.

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 sentence that front-loads the action and sequences the outcome in the order the agent cares about. No filler and no repetition of schema content.

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

Completeness4/5

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

With annotations, a fully documented 8-parameter schema, and an output schema, the remaining burden on the description is low. It covers the import-to-save flow but omits what the returned scene contains and any failure behavior for unsupported formats. The environment is well specified, so it is sufficient for calling the tool correctly.

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 8 parameters are already documented, including overwrite rules and output path constraints. The description's 'apply requested composition options' only gestures vaguely at the boolean flags (snapToGround, centerGeometry, adjustEnvironment, adjustCameraLookAt) without adding meaning. This meets the baseline for high-coverage schemas.

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 ('Import a supported local model') plus the three-stage outcome: base scene, composition options, save a new scene. This separates it from keyshot_save_scene, which saves without import. It stops short of naming a sibling, so it lands at 4 rather than 5.

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 phrase 'into an empty or base scene' implies the preparation context, but there is no explicit when-to-use or when-not-to-use guidance. Nothing tells the agent how this differs from keyshot_sync_saved_scene or keyshot_save_scene in a workflow. Usage is left to inference.

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