KeyShot MCP
NPM · KEYSHOT-MCP
Control local KeyShot scenes, cameras, environments, and renders through headless scripting.
Available components
−3 this week
93 93 Trust /100
Last scanned (17 hours ago)
Scores higher than 96% of npm servers
Category Design and Media
Trust breakdown (7 categories)
How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score → Why this is hard to score →
Supply Chain Security100
- No malware found by supply-chain analysis.Pass
- No known CVEs affecting this package version or its production dependencies.Pass
- No install/post-install scripts declared.Pass
- 0 of 3 dependencies flagged as unhealthy. View diagnostics → Pass
Provenance & Transparency100
- Source repository is publicly reachable at the declared URL. View diagnostics → Pass
- Cryptographically verified build provenance (signed, bound to truman-t3/keyshot-mcp). View diagnostics → Pass
- Clear OSI-approved license (MIT).Pass
- Actively maintained (last published 0 days ago).Pass
- Publishes a security disclosure policy (SECURITY.md).Pass
Schema Quality & AI Usability77
- 100% of prompts and resources have a non-trivial description (not blank, and not just the item's name).Pass
- AI-judged instruction clarity (excellent).Pass
- Context-footprint check failed: tool/resource definitions use about 4051 tokens (~202/item across 20 items; 19 tools + 1 resources), over budget; trim descriptions and params. See how to fix → Fail
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management80
- Stability observed for 24 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 100% of tool parameters carry a description.Pass
- Structured output schemas are declared (100% of tools); any adoption earns full credit.Pass
Tool Safety100
- No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.Pass
- We read all 19 captured tool definition(s), and no name or description among them implies an irreversible operation.Pass
- An AI judge read all 20 captured unit(s) of tool text and found none that tries to manipulate the model reading it.Pass
Capabilities100
- Implements a current MCP spec version (2026-07-28).Pass
What we tested
Checks we ran (16)
- Malware scan
- Known CVEs
- Install scripts
- Dependency health
- Source repository
- Provenance
- License
- Maintenance
- Security disclosure
- Schema quality
- Stability
- Tool coverage
- Injection markers
- Destructive annotations
- Judged manipulation
- MCP protocol
Does not apply to this package (2)
- Endpoint SecurityScored on hosted endpoints only. A package has no live endpoint of its own for us to probe.
- Transport & ReachabilityScored on hosted endpoints only. A package has no live endpoint of its own for us to probe.
The score does not measure everything. What the score does not measure →
Changelog
Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 5 Nov 26 −3
- Stability: pass → 0.80 functional
- 4 Nov 26 0
- Stability: pass → unverified ▼ security
- Tool safety: pass → unverified ▼ security
- Capabilities: pass → unverified ▼ functional
- Tool coverage: 100 → unverified ▼ functional
- Schema quality: 100 → unverified ▼ functional
- Package version: 0.13.5 → 1.0.0 functional
- 29 Oct 26 +1
- Stability: 0.97 → pass security
- 28 Oct 26 −1
- Stability: pass → 0.97 functional
- 22 Oct 26 +1
- Stability: 0.97 → pass security
- 21 Oct 26 +14
- Malware scan: unverified → pass ▲ security
- Stability: pass → 0.97 functional
- 20 Oct 26 −15
- Malware scan: pass → unverified ▼ security
- Schema quality: good → excellent functional
- Package version: 0.13.1 → 0.13.5 functional
- 17 Oct 26 +3
- Stability: 0.80 → pass security
Diagnostics
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 5 Nov 2026 · Analysed npm/keyshot-mcp@1.0.0
Provenance Verified
A signed build attestation was found and verified, binding this exact artifact to the source repository it claims to come from.
| Result | Verified |
|---|---|
| Ecosystem | npm |
| Reason | Verified |
| Discovered via | Registry attestation endpoint |
| Source repo | truman-t3/keyshot-mcp |
| Certificate issuer | https://token.actions.githubusercontent.com |
| Certificate SAN | https://github.com/truman-t3/keyshot-mcp/.github/workflows/npm-publish.yml@refs/tags/v1.0.0 |
| Rekor log index | 3689406799 |
| Predicate type | SLSA build provenance https://slsa.dev/provenance/v1 |
| Subject digest | sha512:867cb4c0ffe9d04ceaf7c582156997ac570d0a1930e1085479844648b984dc359fbd0a31789d0d1888a70d1d400461b1944d7adf56c4a2d5b9f96176f |
Background: How many MCP packages publish verified provenance →
Dependencies 3 packages
| Packages resolved | 3 |
|---|---|
| Tree resolution | Complete |
Background: SBOMs and build attestations, explained →
MCP tools
· 19 exposed
· ~4,030 tokens
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability. A tool's description is untrusted text the model reads on every call, which is what makes this list a security surface and not just an inventory: how tool poisoning works →
Tool
Tokens
keyshot_apply_camera_preset Apply a camera preset ~174
Create or update a saved camera from a configured standard-view or absolute camera preset, then save the edited scene.
| Name | Type | Req | Description |
|---|---|---|---|
| cameraName | string | – | Optional saved camera name. Defaults to the preset name. |
| outputScenePath | string | 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. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| presetName | string | yes | Case-insensitive camera preset name returned by keyshot_list_camera_presets. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_apply_material Apply a KeyShot material ~244
Apply a KeyShot library material or local material file to a specific object, then save the edited scene.
| Name | Type | Req | Description |
|---|---|---|---|
| materialName | string | – | Material name from the local KeyShot library. Provide either materialName or materialPath. |
| materialPath | string | – | Absolute path to a native single-material KeyShot MTL file, not a Wavefront OBJ companion MTL. Provide either materialPath or materialName. |
| objectName | string | – | Scene object name to modify. Provide either objectName or the more specific objectPath. |
| objectPath | string | – | Full scene-tree path of the object to modify. Use this instead of objectName when names are duplicated. |
| outputScenePath | string | 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. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_apply_material_preset Apply a material preset ~196
Resolve a configured material preset, apply it to one scene object, and save a new scene.
| Name | Type | Req | Description |
|---|---|---|---|
| objectName | string | – | Scene object name to modify. Provide either objectName or objectPath. |
| objectPath | string | – | Full scene-tree path to modify. Prefer this when object names are duplicated. |
| outputScenePath | string | 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. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| presetName | string | yes | Case-insensitive material preset name returned by keyshot_list_material_presets. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_batch_render Render selected cameras ~277
Render an explicit list of saved cameras from one scene into an output directory.
| Name | Type | Req | Description |
|---|---|---|---|
| cameras | array | yes | Saved camera names to render in order. Use keyshot_list_cameras first when names are unknown. |
| format | string | – | Output image format. Defaults to PNG when omitted. |
| height | integer | – | Render height in pixels. Overrides the selected quality preset when provided. |
| maxTimeSeconds | number | – | Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples. |
| outputDir | string | yes | Directory for generated render files. Relative paths resolve inside KEYSHOT_OUTPUT_DIR; external paths are rejected by default. |
| overwrite | boolean | – | Whether existing image files may be replaced. Defaults to false. |
| qualityPreset | string | – | Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples). |
| samples | integer | – | Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| width | integer | – | Render width in pixels. Overrides the selected quality preset when provided. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_import_model Import a model into KeyShot ~251
Import a supported local model into an empty or base scene, apply requested composition options, and save a new scene.
| Name | Type | Req | Description |
|---|---|---|---|
| adjustCameraLookAt | boolean | – | Ask KeyShot to retarget the active camera to the imported geometry when supported. |
| adjustEnvironment | boolean | – | Ask KeyShot to adjust the environment to the imported geometry when supported. |
| baseScenePath | string | – | Optional existing KeyShot scene to use as the import base. Omit to start from an empty scene. |
| centerGeometry | boolean | – | Ask KeyShot to center imported geometry during import when supported. |
| modelPath | string | yes | Absolute path to a model file supported by KeyShot, such as OBJ, FBX, STL, or glTF. |
| outputScenePath | string | 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. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| snapToGround | boolean | – | Ask KeyShot to place imported geometry on the ground plane when supported. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_inspect_scene Inspect a KeyShot scene ~63
Open a scene read-only and return metadata, objects, cameras, material assignments, model sets, and external references.
| Name | Type | Req | Description |
|---|---|---|---|
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_list_camera_presets List camera presets ~31
Read the configured camera preset JSON and return valid standard or absolute camera presets without opening KeyShot.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_list_cameras List scene cameras ~59
Return saved camera names without saving changes. Use this before selected-camera rendering when names are unknown.
| Name | Type | Req | Description |
|---|---|---|---|
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_list_material_presets List material presets ~32
Read the configured local material preset JSON and return valid preset names and material sources without opening KeyShot.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_preview_render Render an Agent-visible preview ~247
Render a bounded PNG preview from an existing scene and return it directly as MCP image content. Temporary previews are deleted after embedding; an optional safe output path preserves a copy.
| Name | Type | Req | Description |
|---|---|---|---|
| camera | string | – | Optional saved camera name to activate for the preview. Omit to use the scene's active camera. |
| height | integer | – | Preview height in pixels. Defaults to 540; allowed range is 64 to 1080. |
| maxTimeSeconds | number | – | Time-based preview limit in seconds. Replaces the default sample mode and cannot be combined with an explicit samples value; maximum is 60. |
| outputPath | string | – | Optional .png destination inside KEYSHOT_OUTPUT_DIR. Existing files are never overwritten. When omitted, a temporary preview is embedded and deleted. |
| samples | integer | – | Preview render samples. Defaults to 16 unless maxTimeSeconds is provided; maximum is 64. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| width | integer | – | Preview width in pixels. Defaults to 960; allowed range is 64 to 1920. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_product_render Prepare and render a product ~815
Run a complete product workflow in one headless process: open or import, assign materials, configure camera and environment, save a scene copy, and render one or all cameras.
| Name | Type | Req | Description |
|---|---|---|---|
| adjustCameraLookAt | boolean | – | Retarget the camera after model import. Applies only to modelPath sources and defaults to true for new models. |
| adjustEnvironment | boolean | – | Adjust the environment after model import. Applies only to modelPath sources and defaults to true for new models. |
| baseScenePath | string | – | Optional KeyShot base scene used only when modelPath is provided. |
| brightness | number | – | Positive brightness multiplier for the active environment. |
| cameraName | string | – | Camera to create, update, or activate. New model workflows default to Product Hero. |
| cameraPresetName | string | – | Configured camera preset to apply. Cannot be combined with a custom position/lookAt pair. |
| centerGeometry | boolean | – | Center imported geometry. Applies only to modelPath sources and defaults to true for new models. |
| continueOnError | boolean | – | In allCameras mode, continue after one camera fails. Defaults to true. |
| distance | number | – | Positive KeyShot camera distance applied after the transform or preset. |
| environmentName | string | – | Environment name from the KeyShot library. Cannot be combined with environmentPath. |
| environmentPath | string | – | Absolute path to a local KeyShot environment file. Cannot be combined with environmentName. |
| fieldOfView | number | – | Camera field of view in degrees, greater than 0 and less than 180. Cannot be combined with focalLength. |
| focalLength | number | – | Camera focal length from 5 to 200 mm. Cannot be combined with fieldOfView. |
| format | string | – | Output image format. Defaults to PNG when omitted. |
| height | integer | – | Render height in pixels. Overrides the selected quality preset when provided. |
| lookAt | array | – | Camera target [x, y, z]. Must be provided together with position. |
| materialAssignments | array | – | Object-specific material changes applied before camera and environment setup. |
| maxTimeSeconds | number | – | Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples. |
| modelPath | string | – | Absolute path to a model to import. Provide exactly one modelPath or scenePath. |
| outputDir | string | – | All-cameras output directory. Invalid with single mode; a safe directory is generated when omitted. |
| outputPath | string | – | Single-mode image destination. Invalid with allCameras mode; a safe name is generated when omitted. |
| outputScenePath | string | – | Destination for the prepared scene. A safe numbered name is generated when omitted. |
| overwrite | boolean | – | Allow replacement of explicitly selected output files. Defaults to false. |
| position | array | – | Camera position [x, y, z]. Must be provided together with lookAt. |
| qualityPreset | string | – | Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples). |
| renderMode | string | – | Render one active or named camera, or discover and render every saved camera. Defaults to single. |
| rotation | number | – | Environment rotation in degrees, from 0 inclusive to 360 exclusive. |
| samples | integer | – | Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided. |
| scenePath | string | – | Absolute path to an existing KeyShot scene. Provide exactly one scenePath or modelPath. |
| snapToGround | boolean | – | Place imported geometry on the ground. Applies only to modelPath sources and defaults to true for new models. |
| up | array | – | Optional camera up direction [x, y, z]. Requires position and lookAt. |
| width | integer | – | Render width in pixels. Overrides the selected quality preset when provided. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_render Render one KeyShot view ~282
Render the active or a named camera from an existing scene to an image file.
| Name | Type | Req | Description |
|---|---|---|---|
| camera | string | – | Optional saved camera name to activate before rendering. Omit to use the scene's active camera. |
| format | string | – | Output image format. Defaults to PNG when omitted. |
| height | integer | – | Render height in pixels. Overrides the selected quality preset when provided. |
| maxTimeSeconds | number | – | Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples. |
| outputPath | string | – | Destination image path. When omitted, a PNG name is generated inside KEYSHOT_OUTPUT_DIR. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| qualityPreset | string | – | Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples). |
| samples | integer | – | Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| width | integer | – | Render width in pixels. Overrides the selected quality preset when provided. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_render_all_cameras Render all scene cameras ~282
Discover every saved camera and render each view in one headless process with collision-safe file names and per-camera results.
| Name | Type | Req | Description |
|---|---|---|---|
| continueOnError | boolean | – | Continue rendering remaining cameras after one camera fails. Defaults to true. |
| format | string | – | Output image format. Defaults to PNG when omitted. |
| height | integer | – | Render height in pixels. Overrides the selected quality preset when provided. |
| maxTimeSeconds | number | – | Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples. |
| outputDir | string | yes | Directory for generated render files. Relative paths resolve inside KEYSHOT_OUTPUT_DIR; external paths are rejected by default. |
| overwrite | boolean | – | Whether existing image files may be replaced. Defaults to false. |
| qualityPreset | string | – | Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples). |
| samples | integer | – | Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| width | integer | – | Render width in pixels. Overrides the selected quality preset when provided. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_render_queue Run a sequential render queue ~72
Render independent scene and camera jobs sequentially so KeyShot processes do not compete for a license or output files.
| Name | Type | Req | Description |
|---|---|---|---|
| continueOnError | boolean | – | Continue with later jobs after a failure. Defaults to false. |
| jobs | array | yes | Render jobs executed sequentially to avoid KeyShot license and output conflicts. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_save_scene Save a KeyShot scene copy ~129
Open an existing scene and save a copy to a requested path inside the configured safe output directory.
| Name | Type | Req | Description |
|---|---|---|---|
| outputScenePath | string | 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. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_set_camera Set a KeyShot camera ~297
Create or update a named camera using position, target, distance, field of view, or focal length, then save the edited scene.
| Name | Type | Req | Description |
|---|---|---|---|
| cameraName | string | – | Saved camera to update, or the name to use when creating a camera. |
| distance | number | – | Positive KeyShot camera distance. |
| fieldOfView | number | – | Field of view in degrees, greater than 0 and less than 180. Cannot be combined with focalLength. |
| focalLength | number | – | Focal length from 5 to 200 mm. Cannot be combined with fieldOfView. |
| lookAt | array | – | Camera target [x, y, z]. Must be provided together with position. |
| outputScenePath | string | 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. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| position | array | – | Camera position [x, y, z]. Must be provided together with lookAt. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| up | array | – | Optional camera up direction [x, y, z]. Requires position and lookAt. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_set_environment Set the KeyShot environment ~212
Select an environment by library name or local file, optionally change brightness and rotation, and save the edited scene.
| Name | Type | Req | Description |
|---|---|---|---|
| brightness | number | – | Positive brightness multiplier for the active environment. |
| environmentName | string | – | Environment name from the KeyShot library. Cannot be combined with environmentPath. |
| environmentPath | string | – | Absolute path to a local KeyShot environment file. Cannot be combined with environmentName. |
| outputScenePath | string | 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. |
| overwrite | boolean | – | Allow replacing an existing output file. Defaults to false. Input files can never be replaced, even when true. |
| rotation | number | – | Environment rotation in degrees, from 0 inclusive to 360 exclusive. |
| scenePath | string | yes | Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_status Check KeyShot MCP status ~36
Diagnose the local installation, output access, presets, bridge files, and a minimal KeyShot headless startup without modifying a user scene.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
keyshot_sync_saved_scene Sync the latest saved KeyShot scene ~331
Find a saved .bip file (or the newest .bip in one folder), detect whether it changed, copy it to a collision-safe output path, and optionally return an Agent-visible preview. This is the stable alternative to unsupported persistent GUI control.
| Name | Type | Req | Description |
|---|---|---|---|
| camera | string | – | Optional saved camera name for the embedded preview. Omit to use the scene's active camera. |
| height | integer | – | Preview height in pixels. Defaults to 540; allowed range is 64 to 1080. |
| includePreview | boolean | – | Whether to render and embed a temporary PNG from the synchronized copy. Defaults to true. |
| maxTimeSeconds | number | – | Time-based preview limit in seconds. Replaces the default sample mode and cannot be combined with an explicit samples value; maximum is 60. |
| outputScenePath | string | – | Optional destination for the synchronized .bip copy inside KEYSHOT_OUTPUT_DIR. Existing explicit paths are never overwritten; when omitted, a collision-safe name is generated. |
| previousFingerprint | string | – | Optional fingerprint returned by an earlier sync. When it still matches, no copy or preview is created. |
| samples | integer | – | Preview render samples. Defaults to 16 unless maxTimeSeconds is provided; maximum is 64. |
| sourcePath | string | yes | Absolute path to a saved .bip scene or a directory whose newest .bip scene should be synchronized. Directories are searched only at their top level. |
| width | integer | – | Preview width in pixels. Defaults to 960; allowed range is 64 to 1920. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | – | yes | Operation-specific structured result data, or null when unavailable. |
| error | string|null | yes | Human-readable failure reason, or null after success. |
| errorCode | string|null | – | Stable error category for common failures. |
| keyshotStdoutTail | string | yes | Truncated tail of KeyShot headless output for diagnostics. |
| ok | boolean | yes | True when the requested operation completed successfully. |
| outputFiles | array | yes | Absolute paths of images or scene files created by the operation. |
| suggestions | array | – | Actionable recovery steps for the user or agent. |
| warnings | array | yes | Non-fatal conditions the user or agent should review. |
No examples provided.
Install
How do I install the KeyShot MCP server?
KeyShot MCP runs locally as an npm package, launched with npx -y keyshot-mcp. Ready-made configuration for Claude, Cursor, VS Code, Codex and 5 more is on this page, copied from each client's own documentation.
npm · keyshot-mcp
# add to Claude Code
claude mcp add truman-t3-keyshot-mcp -- npx -y keyshot-mcp
Common questions
What is the KeyShot MCP server?
KeyShot MCP is listed in the public MCP registry as io.github.truman-t3/keyshot-mcp. Control local KeyShot scenes, cameras, environments, and renders through headless scripting. This page covers its npm package (keyshot-mcp).
Is the KeyShot MCP server safe to use?
KeyShot MCP scores 93 out of 100 on VerifyMCP. We found no known CVEs affecting it as of 5 November 2026. It declares no install or post-install scripts. Its build provenance is signed and verified. That is a record of what we were able to check automatically, not an endorsement. The category breakdown on this page shows every signal behind the number, including the ones we could not confirm.
What tools does the KeyShot MCP server expose?
KeyShot MCP exposes 19 tools: keyshot_status, keyshot_product_render, keyshot_inspect_scene, keyshot_list_cameras, keyshot_preview_render, and 14 more. Their descriptions and schemas cost roughly 4,030 tokens of context every time the server is loaded.
Is the KeyShot MCP server still maintained?
KeyShot MCP is still listed as active in the MCP registry. We last reached this channel on 5 November 2026. Those dates come from our own scans of the registry and the channel itself, not from anything the publisher announced.
What licence is the KeyShot MCP server under?
KeyShot MCP declares the MIT licence, which is OSI-approved. That covers the source only, and says nothing about the cost of any service it calls.
What did VerifyMCP test on the KeyShot MCP server?
VerifyMCP ran 16 checks on KeyShot MCP, covering Malware scan, Known CVEs, Install scripts, Dependency health and 12 more. Endpoint Security and Transport & Reachability do not apply to an npm package, so they were not tested. The score does not measure everything, and the scoring documentation lists what it leaves out.