Skip to main content
Glama

Save a KeyShot scene copy

keyshot_save_scene
Destructive

Open an existing KeyShot scene and save a copy to a requested path inside the configured safe output directory.

Instructions

Open an existing scene and save a copy to a requested path inside the configured safe output directory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scenePathYesAbsolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory.
outputScenePathYesDestination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled.

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. Changed4 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
    • 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. Changed3 schema fields changedv0.10.0
    • addedInput schema / properties / outputScenePath / description
      Added value: +"Destination path for the saved KeyShot scene. The path must stay inside KEYSHOT_OUTPUT_DIR unless external outputs are explicitly enabled."
    • 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."
    • 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

B3.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false. The description adds useful scoping context (the safe output directory, input files allowed outside it) but never explains what is destructive — e.g. whether an existing file at outputScenePath is overwritten — which is the key behavior the destructive hint flags.

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?

A single front-loaded sentence with no filler. The operation and its destination constraint come first, and nothing is wasted.

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 an output schema present, return values need no explanation, and both required parameters are covered. The only real gap is the unaddressed destructive behavior (overwrite semantics), which matters given destructiveHint=true.

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 both parameters are already fully documented in the schema, including the output-directory restriction. The description's mention of the safe output directory restates that constraint rather than adding new meaning; 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?

The description names a specific verb pair (open + save a copy) and the resource (KeyShot scene), plus the destination constraint. It is clear what the tool does, though it does not explicitly distinguish itself from the similar-sounding sibling keyshot_sync_saved_scene.

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 is given, and no alternatives are named. The presence of a sibling named keyshot_sync_saved_scene makes the omission notable, since an agent must guess which one applies to its situation.

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