Skip to main content
Glama

Set the KeyShot environment

keyshot_set_environment
Destructive

Set a KeyShot scene's environment from library or local file, adjust brightness and rotation, then save the edited scene.

Instructions

Select an environment by library name or local file, optionally change brightness and rotation, and save the edited scene.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rotationNoEnvironment rotation in degrees, from 0 inclusive to 360 exclusive.
scenePathYesAbsolute path to an existing KeyShot scene file to open. Input files may be outside the configured output directory.
brightnessNoPositive brightness multiplier for the active environment.
environmentNameNoEnvironment name from the KeyShot library. Cannot be combined with environmentPath.
environmentPathNoAbsolute path to a local KeyShot environment file. Cannot be combined with environmentName.
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.
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?

The description states it 'save[s] the edited scene', which is consistent with the destructiveHint=true annotation. It also discloses that it selects an environment and optionally changes brightness/rotation, providing behavioral context beyond the hint. No contradictions found.

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 a single sentence that front-loads the core purpose, then lists optional adjustments and the save action. Every word earns its place with no 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?

The description covers the key aspects: selection methods, optional parameters, and saving behavior. With an output schema present and annotations disclosing destructive behavior, the description does not need to explain return values or safety. It is complete enough for a tool with six parameters and two required fields.

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 schema already explains all parameters (e.g., environmentName vs environmentPath mutual exclusion, outputScenePath destination). The description adds a little by saying 'optionally change brightness and rotation' and 'select by library name or local file', but this mostly reflects existing schema descriptions. 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-resource pair: 'Select an environment' and then explains the optional modifications and save action. It clearly distinguishes from sibling tools like keyshot_set_camera (camera setup) and keyshot_save_scene (just saving), as this tool combines environment selection/editing with saving.

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 gives clear context on when to use: when the user wants to change the environment in a KeyShot scene by library name or local file, adjust brightness/rotation, and save the result. It does not explicitly mention exclusions or alternatives, but the purpose is stated clearly enough that an agent can infer its use case.

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