KeyShot MCP
NPM · KEYSHOT-MCP · SCANNED AUG 3
Control local KeyShot scenes, cameras, environments, and renders through headless scripting.
Available components
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 →
Supply Chain Security87
- No malware found by supply-chain analysis.Pass
- Only part of the dependency tree could be resolved (95 of 99), so this covers what we could see, not the whole tree.Partial
- No install/post-install scripts declared.Pass
- Only part of the dependency tree could be resolved (95 of 99), so this covers what we could see, not the whole tree. View diagnostics → Partial
Provenance & Transparency97
- 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
- Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail
Schema Quality & AI Usability80
- 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 3535 tokens (~196/item across 18 items; 17 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 Management23
- Stability observed for 7 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
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.
npm · keyshot-mcp
claude mcp add truman-t3-keyshot-mcp -- npx -y keyshot-mcp
codex mcp add truman-t3-keyshot-mcp -- npx -y keyshot-mcp
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"truman-t3-keyshot-mcp": {
"type": "local",
"command": [
"npx",
"-y",
"keyshot-mcp"
],
"enabled": true
}
}
} openclaw mcp add truman-t3-keyshot-mcp --command npx --arg -y --arg keyshot-mcp
mcp_servers:
truman-t3-keyshot-mcp:
command: "npx"
args: ["-y", "keyshot-mcp"] {
"mcpServers": {
"truman-t3-keyshot-mcp": {
"command": "npx",
"args": [
"-y",
"keyshot-mcp"
]
}
}
} 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.
- 3 Aug 26 +10
- Schema quality: pass → fail ▼ functional
- Tool coverage: 0% → 100% ▲ functional
- Stability: unverified → 0.23 ▲ functional
- First check of Tool coverage: 100 functional
- Schema quality: poor → excellent functional
- Package version: 0.9.0 → 0.9.1 functional
- 2 Aug 26 +42
- Provenance: unverified → pass ▲ security
- Install scripts: unverified → pass ▲ security
- Known CVEs: unverified → partial ▲ security
- Malware scan: unverified → pass ▲ security
- Stability: Stability not yet verified: we do not have a sandbox capture of the MCP schema this version of the package serves yet. security
- The attested source repository moved: truman-t3/keyshot-mcp security
- Schema quality: 100 → unverified ▼ functional
- Security disclosure: fail → unverified ▼ functional
- Capabilities: pass → unverified ▼ functional
- Tool coverage: 100 → unverified ▼ functional
- License: unverified → pass ▲ functional
- Dependency health: unverified → partial ▲ functional
- Maintenance: unverified → pass ▲ functional
- Schema quality: unverified → poor ▲ functional
- Licence: MIT functional
- 1 Aug 26 +5
- Stability: Stability not yet verified: not enough scan history yet (needs a 30-day window). security
- MCP protocol: unverified → pass ▲ functional
- 31 Jul 26 −1
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 30 Jul 26 −24
- Tool coverage: 100 → unverified ▼ functional
- Schema quality: 100 → unverified ▼ functional
- 27 Jul 26 48
First indexed and scored.
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 3 Aug 2026 · Analysed npm/[email protected]
Provenance verified
Ecosystem: npm · Outcome: verified
Reason: verified
- 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/v0.9.1
- Rekor log index:
- 2333555629
- Predicate type:
- https://slsa.dev/provenance/v1
- Subject digest:
- sha512:2023ff5be0f38b78344f366c28c0b036b54871953d3d412cea3f2e867cc67a5e09686129bb8e6a9a7276820295406cdfb7c999504c525d0e8f0d12c66
- Discovery method:
- attestation_endpoint
Dependencies 95 packages
95 packages in the resolved dependency tree · 95 deprecated · 29 stale.
The dependency tree was only partially resolved, so these counts may be incomplete.
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.
keyshot_apply_camera_preset Apply a camera preset ~158
Create or update a saved camera from a configured standard view or absolute camera preset, then save the edited scene. List camera presets first when the name is unknown; use keyshot_set_camera for direct transform or lens control.
| Name | Type | Req | Description |
|---|---|---|---|
| cameraName | string | — | Optional saved camera name. Defaults to the preset name. |
| outputScenePath | string | yes | Destination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
| 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 | — | — | 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 ~223
Apply one KeyShot library material name or local material file to a specific scene object, then save the edited scene to the requested output path. Use objectPath when duplicate object names exist; use keyshot_apply_material_preset for a configured reusable preset.
| Name | Type | Req | Description |
|---|---|---|---|
| materialName | string | — | Material name from the local KeyShot library. Provide either materialName or materialPath. |
| materialPath | string | — | Absolute path to a local KeyShot material file. 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 the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
| 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 | — | — | 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 ~188
Resolve a named preset from the configured material preset library, apply it to one scene object, and save a new KeyShot scene. List presets first when the name is unknown; use keyshot_apply_material for a direct library name or material file.
| 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 the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
| 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 | — | — | 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 ~308
Render an explicit list of saved camera names from one KeyShot scene into an output directory. Use keyshot_list_cameras first when camera names are unknown; use keyshot_render_all_cameras to discover and render every camera automatically.
| 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 | — | — | 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 ~238
Import a supported local model into an empty scene or optional base scene, apply requested import composition options, and save the result to a new scene path. This tool does not render; use keyshot_product_render for an import-to-image workflow.
| 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 the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
| snapToGround | boolean | — | Ask KeyShot to place imported geometry on the ground plane when supported. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | — | 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 ~80
Open an existing KeyShot scene read-only and return scene metadata, objects, cameras, material assignments, model sets, and external references. Use this before targeted material or camera edits 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 | — | — | 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 ~46
Read the configured camera preset JSON and return valid standard or absolute camera presets without opening KeyShot or modifying files. Use a returned name with keyshot_apply_camera_preset.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | — | 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 ~84
Open a KeyShot scene without saving changes and return its saved camera names. Use this before keyshot_batch_render when only selected views should be rendered; use keyshot_render_all_cameras when no manual selection is needed.
| 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 | — | — | 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 ~47
Read the configured local material preset JSON and return valid preset names and material sources without opening KeyShot or modifying files. Use a returned name with keyshot_apply_material_preset.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | — | 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 ~841
Use this high-level tool for a complete product workflow in one KeyShot headless process: open a scene or import a model, apply object-specific materials, configure camera and environment, save a scene copy, and render one or all cameras. Prefer lower-level tools only when the individual stages need separate control.
| 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 | — | — | 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 ~286
Render one active or named camera from an existing KeyShot scene to an image file. Use keyshot_batch_render for selected cameras, keyshot_render_all_cameras for every camera, or keyshot_product_render when scene preparation is also required.
| 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. |
| 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 | — | — | 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 ~303
Discover every saved camera in a KeyShot scene and render each view in one headless process. Safe file names are generated from camera names; duplicate names are numbered and per-camera failures can be reported while remaining views continue.
| 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 | — | — | 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 ~85
Render multiple independent scene and camera jobs sequentially so KeyShot processes do not compete for a license or output files. Stops after the first failure unless continueOnError is enabled.
| 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 | — | — | 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 ~110
Open an existing KeyShot scene and save it to a requested output path inside the configured safe output directory. Use this for an explicit scene copy; editing tools already save their own output scenes.
| Name | Type | Req | Description |
|---|---|---|---|
| outputScenePath | string | yes | Destination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
| 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 | — | — | 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 ~281
Create or update a named camera using a position and target, distance, field of view, or focal length, then save the edited scene. Position and lookAt must be supplied together; fieldOfView and focalLength select mutually exclusive lens modes.
| 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 the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
| 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 | — | — | 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 ~190
Select a KeyShot environment by library name or local file, optionally change brightness and rotation, and save the edited scene. Unsupported environment APIs return a clear error instead of silently ignoring requested changes.
| 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 the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled. |
| 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 | — | — | 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 ~46
Diagnose the local KeyShot MCP installation before editing or rendering. Checks configuration, 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 | — | — | 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.