Skip to main content
Glama

Render one KeyShot view

keyshot_render
Destructive

Render an existing KeyShot scene to an image file using the active or a named saved camera.

Instructions

Render the active or a named camera from an existing scene to an image file.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
widthNoRender width in pixels. Overrides the selected quality preset when provided.
cameraNoOptional saved camera name to activate before rendering. Omit to use the scene's active camera.
formatNoOutput image format. Defaults to PNG when omitted.
heightNoRender height in pixels. Overrides the selected quality preset when provided.
samplesNoMaximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided.
scenePathYesAbsolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory.
outputPathNoDestination image path. When omitted, a PNG name is generated inside KEYSHOT_OUTPUT_DIR.
qualityPresetNoRender quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples).
maxTimeSecondsNoMaximum render time in seconds. Selects time-based rendering and cannot be combined with samples.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesTrue when the requested operation completed successfully.
dataYesOperation-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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.13.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / height / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / samples / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / width / maximum
      Added value: +9007199254740991
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / required
      Previous value: -[
      -  "ok",
      -  "outputFiles",
      -  "warnings",
      -  "keyshotStdoutTail",
      -  "error"
      -]New value: +[
      +  "ok",
      +  "data",
      +  "outputFiles",
      +  "warnings",
      +  "keyshotStdoutTail",
      +  "error"
      +]
  2. Changed10 schema fields changedv0.10.0
    • addedInput schema / properties / camera / description
      Added value: +"Optional saved camera name to activate before rendering. Omit to use the scene's active camera."
    • addedInput schema / properties / format / description
      Added value: +"Output image format. Defaults to PNG when omitted."
    • addedInput schema / properties / height / description
      Added value: +"Render height in pixels. Overrides the selected quality preset when provided."
    • addedInput schema / properties / maxTimeSeconds / description
      Added value: +"Maximum render time in seconds. Selects time-based rendering and cannot be combined with samples."
    • addedInput schema / properties / outputPath / description
      Added value: +"Destination image path. When omitted, a PNG name is generated inside KEYSHOT_OUTPUT_DIR."
    • addedInput schema / properties / qualityPreset
      Added value: +{
      +  "description": "Render quality preset: preview (960x540, 16 samples), standard (1920x1080, 64 samples), or final (3840x2160, 256 samples).",
      +  "enum": [
      +    "preview",
      +    "standard",
      +    "final"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / samples / description
      Added value: +"Maximum render samples. Cannot be combined with maxTimeSeconds and overrides preset sampling when provided."
    • addedInput schema / properties / scenePath / description
      Added value: +"Absolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory."
    • addedInput schema / properties / width / description
      Added value: +"Render width in pixels. Overrides the selected quality preset when provided."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "anyOf": [
      +        {},
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Operation-specific structured result data, or null when unavailable."
      +    },
      +    "error": {
      +      "description": "Human-readable failure reason, or null after success.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "errorCode": {
      +      "description": "Stable error category for common failures.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "keyshotStdoutTail": {
      +      "description": "Truncated tail of KeyShot headless output for diagnostics.",
      +      "type": "string"
      +    },
      +    "ok": {
      +      "description": "True when the requested operation completed successfully.",
      +      "type": "boolean"
      +    },
      +    "outputFiles": {
      +      "description": "Absolute paths of images or scene files created by the operation.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "suggestions": {
      +      "description": "Actionable recovery steps for the user or agent.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "warnings": {
      +      "description": "Non-fatal conditions the user or agent should review.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "ok",
      +    "outputFiles",
      +    "warnings",
      +    "keyshotStdoutTail",
      +    "error"
      +  ],
      +  "type": "object"
      +}
  3. First observedv0.2.1

TDQS

C2.9/5.0
Behavior2/5

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

Annotations declare destructiveHint=true, readOnlyHint=false and idempotentHint=false, but the description says nothing about overwriting an existing outputPath, permission requirements, or what a render run actually modifies. With annotations carrying the safety profile, the description should at least flag the overwrite/queue behavior, and it does not.

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

Conciseness4/5

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

A single front-loaded sentence with no waste, though it is arguably thin for a nine-parameter rendering tool rather than optimally sized.

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

Completeness2/5

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

For a nine-parameter, non-idempotent render tool with several near-identical siblings, an output schema and rich annotations, the description leaves the agent without routing guidance or output/overwrite semantics. The schema and output schema cover the mechanical details, but the definition does not fill the remaining gaps.

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 every parameter, including enums for format and qualityPreset and mutual exclusions for samples/maxTimeSeconds, is documented in the schema. The description adds no parameter meaning beyond it, so the baseline 3 applies.

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

Purpose4/5

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

States a specific verb (render) and resource (active or named camera from an existing scene) with the output being an image file. It does not, however, distinguish itself from the many sibling render tools (preview_render, product_render, batch_render, render_all_cameras), so the agent must infer the boundary.

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

Usage Guidelines2/5

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

No when-to-use guidance and no mention of alternatives, despite five sibling tools that also render. An agent cannot tell from this sentence why it would pick keyshot_render over keyshot_preview_render or keyshot_render_all_cameras.

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