Skip to main content
Glama

Render an Agent-visible preview

keyshot_preview_render
Read-onlyIdempotent

Render a PNG preview from an existing KeyShot scene and return it as image content. Optionally save a copy to a safe output path; temporary previews are deleted after embedding.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
widthNoPreview width in pixels. Defaults to 960; allowed range is 64 to 1920.
cameraNoOptional saved camera name to activate for the 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.
scenePathYesAbsolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory.
outputPathNoOptional .png destination inside KEYSHOT_OUTPUT_DIR. Existing files are never overwritten. When omitted, a temporary preview is embedded and deleted.
maxTimeSecondsNoTime-based preview limit in seconds. Replaces the default sample mode and cannot be combined with an explicit samples value; maximum is 60.

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

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

The description discloses that temporary previews are deleted after embedding, which is a non-obvious behavioral detail beyond the readOnly/idempotent/non-destructive annotations. It also explains that an optional output path preserves a copy, aligning with the schema's 'never overwrites' guarantee.

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 primary action, and the second sentence efficiently conveys the temporary-file lifecycle. No superfluous content.

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?

The tool has 7 parameters and an output schema, so the description need not detail returns or every parameter. It covers the two most important behavioral caveats—temporary deletion and optional persistence—while annotations and schema cover the rest, making it sufficiently complete.

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% and the description adds no parameter-specific syntax beyond what is already in the input schema. The phrase 'safe output path preserves a copy' mirrors the schema's outputPath description, providing no additional semantic 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 renders a bounded PNG preview from an existing scene and returns it directly as MCP image content. This specific verb-resource-output combination distinguishes it from sibling render tools like keyshot_render or keyshot_batch_render, which likely produce full-resolution files.

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

Usage Guidelines4/5

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

The description implies the tool is for bounded previews delivered as image content, which fits quick visual checks, but it does not explicitly compare to sibling tools or state exclusions. The context is clear but lacks direct guidance such as 'use this instead of keyshot_render for fast previews.'

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