Skip to main content
Glama

Prepare and render a product

keyshot_product_render
Destructive

Run a complete product rendering pipeline in one headless KeyShot process: import or open models, assign materials, configure camera and environment, save scene, and render one or all cameras.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
upNoOptional camera up direction [x, y, z]. Requires position and lookAt.
widthNoRender width in pixels. Overrides the selected quality preset when provided.
formatNoOutput image format. Defaults to PNG when omitted.
heightNoRender height in pixels. Overrides the selected quality preset when provided.
lookAtNoCamera target [x, y, z]. Must be provided together with position.
samplesNoMaximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided.
distanceNoPositive KeyShot camera distance applied after the transform or preset.
positionNoCamera position [x, y, z]. Must be provided together with lookAt.
rotationNoEnvironment rotation in degrees, from 0 inclusive to 360 exclusive.
modelPathNoAbsolute path to a model to import. Provide exactly one modelPath or scenePath.
outputDirNoAll-cameras output directory. Invalid with single mode; a safe directory is generated when omitted.
overwriteNoAllow replacement of explicitly selected output files. Defaults to false.
scenePathNoAbsolute path to an existing KeyShot scene. Provide exactly one scenePath or modelPath.
brightnessNoPositive brightness multiplier for the active environment.
cameraNameNoCamera to create, update, or activate. New model workflows default to Product Hero.
outputPathNoSingle-mode image destination. Invalid with allCameras mode; a safe name is generated when omitted.
renderModeNoRender one active or named camera, or discover and render every saved camera. Defaults to single.single
fieldOfViewNoCamera field of view in degrees, greater than 0 and less than 180. Cannot be combined with focalLength.
focalLengthNoCamera focal length from 5 to 200 mm. Cannot be combined with fieldOfView.
snapToGroundNoPlace imported geometry on the ground. Applies only to modelPath sources and defaults to true for new models.
baseScenePathNoOptional KeyShot base scene used only when modelPath is provided.
qualityPresetNoRender quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples).
centerGeometryNoCenter imported geometry. Applies only to modelPath sources and defaults to true for new models.
maxTimeSecondsNoMaximum render time in seconds. Selects time-based rendering and cannot be combined with samples.
continueOnErrorNoIn allCameras mode, continue after one camera fails. Defaults to true.
environmentNameNoEnvironment name from the KeyShot library. Cannot be combined with environmentPath.
environmentPathNoAbsolute path to a local KeyShot environment file. Cannot be combined with environmentName.
outputScenePathNoDestination for the prepared scene. A safe numbered name is generated when omitted.
cameraPresetNameNoConfigured camera preset to apply. Cannot be combined with a custom position/lookAt pair.
adjustEnvironmentNoAdjust the environment after model import. Applies only to modelPath sources and defaults to true for new models.
adjustCameraLookAtNoRetarget the camera after model import. Applies only to modelPath sources and defaults to true for new models.
materialAssignmentsNoObject-specific material changes applied before camera and environment setup.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesTrue when the requested operation completed successfully.
dataNoOperation-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.
Behavior3/5

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

The annotations already declare destructiveHint=true. The description adds useful context such as 'headless process' and 'save a scene copy,' but it does not disclose details about overwrite behavior, error handling in allCameras mode, or what happens to the original scene. This is moderate additional value beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One sentence with a colon-separated list, front-loaded with the action, and every phrase earns its place. No redundant filler or restatement of the title.

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?

For a tool with 32 parameters, a single overview sentence is relatively thin. It omits important modes (single vs allCameras), mutual-exclusion constraints (modelPath vs scenePath), and overwrite behavior—though these are all covered in the schema. The description gives a helpful overview but isn't sufficient for an agent to fully understand the workflow without deep schema inspection.

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 coverage is 100% with every parameter described. The description groups steps (assign materials, configure camera/environment, save scene copy, render) that map to parameter families, but it does not introduce any semantics beyond what the schema already provides. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Run') and resource ('complete product workflow'), with a concrete list of steps that clearly distinguishes this from single-purpose sibling tools like keyshot_import_model, keyshot_apply_material, or keyshot_render. It immediately signals the tool's all-in-one scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'complete product workflow' implies end-to-end use, but the description never explicitly says when to prefer this over individual sibling tools, nor does it mention exclusions or alternatives. Usage context is implied rather than stated, so it earns a 3.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/truman-t3/keyshot-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server