KeyShot MCP

Overview Schema Source Related Servers Discussions Admin

Import a model into KeyShot

keyshot_import_model

Destructive

Import local OBJ, FBX, STL, or glTF models into an empty or base KeyShot scene, apply 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

TableJSON Schema

Name	Required	Description
`modelPath`	Yes	Absolute path to a model file supported by KeyShot, such as OBJ, FBX, STL, or glTF.
`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 the saved KeyShot scene. The path 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

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.

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.5/5.0

Behavior3/5

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

Annotations already declare the safety profile (destructiveHint=true, idempotentHint=false), so the description only needs to enrich it. It does add that a new scene is written, but it does not state what gets destroyed (does it overwrite an existing outputScenePath file?), that the operation is not idempotent, or any failure behavior. Some added value, but the destructive consequence is left implicit.

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 that sequences the three actions (import, compose, save) with no filler or repetition. Every clause carries information.

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 described, and the 100%-covered schema carries the parameter burden. What is missing is the mutation-risk context an agent needs for a destructive, non-idempotent tool: overwrite semantics for outputScenePath, whether an existing scene is replaced, and any environmental prerequisites.

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 seven parameters are already documented with meaning and constraints (model formats, KEYSHOT_OUTPUT_DIR rule, 'when supported' caveats). The description only gestures at 'requested composition options', which adds no semantics 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 concrete verb+resource ('Import a supported local model') and scopes it to a specific target ('empty or base scene') followed by a save step, so an agent can distinguish it from the render/material/camera siblings. It does not explicitly name which sibling to use instead for plain scene saving, so it falls just short of a 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' plus the baseScenePath semantics implies when this tool applies (starting a new scene), but there is no explicit when-not guidance, no mention of prerequisites (e.g. KeyShot must be running, scene must not be locked), and no pointer to keyshot_save_scene for simple save cases. Usage is inferable rather than stated.

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