Skip to main content
Glama

Sync the latest saved KeyShot scene

keyshot_sync_saved_scene
Destructive

Detects changes in a saved KeyShot .bip scene, copies it to a collision-safe destination, and returns an optional preview render.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
widthNoPreview width in pixels. Defaults to 960; allowed range is 64 to 1920.
cameraNoOptional saved camera name for the embedded preview. Omit to use the scene's active camera.
heightNoPreview height in pixels. Defaults to 540; allowed range is 64 to 1080.
samplesNoPreview render samples. Defaults to 16 unless maxTimeSeconds is provided; maximum is 64.
sourcePathYesAbsolute path to a saved .bip scene or a directory whose newest .bip scene should be synchronized. Directories are searched only at their top level.
includePreviewNoWhether to render and embed a temporary PNG from the synchronized copy. Defaults to true.
maxTimeSecondsNoTime-based preview limit in seconds. Replaces the default sample mode and cannot be combined with an explicit samples value; maximum is 60.
outputScenePathNoOptional destination for the synchronized .bip copy inside KEYSHOT_OUTPUT_DIR. Existing explicit paths are never overwritten; when omitted, a collision-safe name is generated.
previousFingerprintNoOptional fingerprint returned by an earlier sync. When it still matches, no copy or preview is created.

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

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

Annotations already flag destructiveHint=true, lowering the burden. The description adds useful behavioral context: it detects changes, copies to a collision-safe path (avoiding overwrites), and optionally returns a preview. It also notes the tool is a stable alternative to GUI control, giving insight into its operating style. No contradictions with 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?

The description is two sentences, front-loaded with the core workflow, and contains no filler. It efficiently conveys the main actions and the key differentiator (stable alternative to GUI control) without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 9 parameters and an output schema, the description provides a solid high-level overview of the workflow, covering the main steps and the preview option. It does not delve into all edge cases, but the schema and output schema fill in the necessary detail. The description is complete enough for an agent to understand the tool's role and scope.

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 baseline is 3. The description's reference to 'collision-safe output path' and 'detect whether it changed' aligns with outputScenePath and previousFingerprint, but it does not add additional meaning beyond the schema. The schema already explains all parameters clearly, so the description adds minimal incremental value.

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 clearly states the tool's function: find a .bip file, detect changes, copy to a collision-safe path, and optionally generate a preview. It names the specific resource (.bip) and scope (newest in one folder). It also distinguishes itself as the stable alternative to unsupported persistent GUI control, setting it apart from sibling tools focused on rendering or scene inspection.

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 description implies usage when syncing saved KeyShot scenes is needed and positions it as an alternative to GUI control. However, it does not explicitly state when to use this tool versus sibling tools like keyshot_save_scene or keyshot_inspect_scene, and gives no exclusion criteria. The guidance is implied rather than explicit.

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