Skip to main content
Glama
truman-t3

KeyShot MCP

by truman-t3
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Set a KeyShot camera

keyshot_set_camera
Destructive

Create or update a named KeyShot camera using position, target, distance, field of view, or focal length, then save the edited scene.

Instructions

Create or update a named camera using position, target, distance, field of view, or focal length, then save the edited scene.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
upNoOptional camera up direction [x, y, z]. Requires position and lookAt.
lookAtNoCamera target [x, y, z]. Must be provided together with position.
distanceNoPositive KeyShot camera distance.
positionNoCamera position [x, y, z]. Must be provided together with lookAt.
scenePathYesAbsolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory.
cameraNameNoSaved camera to update, or the name to use when creating a camera.
fieldOfViewNoField of view in degrees, greater than 0 and less than 180. Cannot be combined with focalLength.
focalLengthNoFocal length from 5 to 200 mm. Cannot be combined with fieldOfView.
outputScenePathYesDestination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesTrue when the requested operation completed successfully.
dataYesOperation-specific structured result data, or null when unavailable.
errorYesHuman-readable failure reason, or null after success.
warningsYesNon-fatal conditions the user or agent should review.
errorCodeNoStable error category for common failures.
outputFilesYesAbsolute paths of images or scene files created by the operation.
suggestionsNoActionable recovery steps for the user or agent.
keyshotStdoutTailYesTruncated tail of KeyShot headless output for diagnostics.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv0.13.0
    • 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
    • changedInput schema / properties / lookAt / items
      Previous value: -[
-  {
-    "$ref": "#/properties/position/items/0"
-  },
-  {
-    "$ref": "#/properties/position/items/1"
-  },
-  {
-    "$ref": "#/properties/position/items/2"
-  }
-]New value: +false
    • addedInput schema / properties / lookAt / prefixItems
      Added value: +[
+  {
+    "type": "number"
+  },
+  {
+    "type": "number"
+  },
+  {
+    "type": "number"
+  }
+]
    • changedInput schema / properties / position / items
      Previous value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "number"
-  },
-  {
-    "type": "number"
-  }
-]New value: +false
    • addedInput schema / properties / position / prefixItems
      Added value: +[
+  {
+    "type": "number"
+  },
+  {
+    "type": "number"
+  },
+  {
+    "type": "number"
+  }
+]
    • changedInput schema / properties / up / items
      Previous value: -[
-  {
-    "$ref": "#/properties/position/items/0"
-  },
-  {
-    "$ref": "#/properties/position/items/1"
-  },
-  {
-    "$ref": "#/properties/position/items/2"
-  }
-]New value: +false
    • addedInput schema / properties / up / prefixItems
      Added value: +[
+  {
+    "type": "number"
+  },
+  {
+    "type": "number"
+  },
+  {
+    "type": "number"
+  }
+]
    • 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"
+]
  2. Changed21 schema fields changedv0.10.0
    • addedInput schema / properties / cameraName / description
      Added value: +"Saved camera to update, or the name to use when creating a camera."
    • addedInput schema / properties / distance / description
      Added value: +"Positive KeyShot camera distance."
    • addedInput schema / properties / fieldOfView
      Added value: +{
+  "description": "Field of view in degrees, greater than 0 and less than 180. Cannot be combined with focalLength.",
+  "exclusiveMaximum": 180,
+  "exclusiveMinimum": 0,
+  "type": "number"
+}
    • addedInput schema / properties / focalLength
      Added value: +{
+  "description": "Focal length from 5 to 200 mm. Cannot be combined with fieldOfView.",
+  "maximum": 200,
+  "minimum": 5,
+  "type": "number"
+}
    • removedInput schema / properties / lookAt / $ref
      Removed value: -"#/properties/position"
    • addedInput schema / properties / lookAt / description
      Added value: +"Camera target [x, y, z]. Must be provided together with position."
    • addedInput schema / properties / lookAt / items
      Added value: +[
+  {
+    "$ref": "#/properties/position/items/0"
+  },
+  {
+    "$ref": "#/properties/position/items/1"
+  },
+  {
+    "$ref": "#/properties/position/items/2"
+  }
+]
    • addedInput schema / properties / lookAt / maxItems
      Added value: +3
    • addedInput schema / properties / lookAt / minItems
      Added value: +3
    • addedInput schema / properties / lookAt / type
      Added value: +"array"
    • 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 / position / description
      Added value: +"Camera position [x, y, z]. Must be provided together with lookAt."
    • 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."
    • removedInput schema / properties / up / $ref
      Removed value: -"#/properties/position"
    • addedInput schema / properties / up / description
      Added value: +"Optional camera up direction [x, y, z]. Requires position and lookAt."
    • addedInput schema / properties / up / items
      Added value: +[
+  {
+    "$ref": "#/properties/position/items/0"
+  },
+  {
+    "$ref": "#/properties/position/items/1"
+  },
+  {
+    "$ref": "#/properties/position/items/2"
+  }
+]
    • addedInput schema / properties / up / maxItems
      Added value: +3
    • addedInput schema / properties / up / minItems
      Added value: +3
    • addedInput schema / properties / up / type
      Added value: +"array"
    • changedInput schema / required
      Previous value: -[
-  "scenePath",
-  "position",
-  "lookAt",
-  "outputScenePath"
-]New value: +[
+  "scenePath",
+  "outputScenePath"
+]
    • 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"
+}
  3. First observedv0.2.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare the write/destructive/idempotent profile (readOnlyHint=false, destructiveHint=true, idempotentHint=false), so the bar is lower. The description adds the useful side-effect that the scene is saved, but does not disclose what destructiveHint means here (e.g., an existing camera of the same cameraName being overwritten, or outputScenePath being clobbered).

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 tight sentence with the action front-loaded and no filler. It could arguably be split to front-load the required scenePath/outputScenePath behavior, but nothing is wasted.

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 9 parameters, full schema coverage, an output schema, and rich annotations, the definition is adequate but thin: it omits the required input/output scene paths, the cameraName update-vs-create semantics, and the optional 'up' vector, so an agent still needs the schema to call it 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 the schema already documents every parameter including mutual exclusions (fieldOfView vs focalLength, position+lookAt coupling). The description only restates a subset of these fields in prose and adds no format or constraint detail beyond the schema.

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?

The description states a specific verb+resource pair ('Create or update a named camera') and enumerates the geometry inputs (position, target, distance, FOV, focal length), plus the save step. It is clearly distinguishable from list/inspect/preset siblings, though it never names an alternative directly.

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 when-to-use guidance and no routing against the obvious alternatives (keyshot_apply_camera_preset, keyshot_list_cameras, keyshot_apply_camera_preset). The agent is left to infer when creating a custom camera beats applying a preset.

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

Deploy Server

Other Tools