Skip to main content
Glama

save_scene

Destructive

Writes the open stage's root layer to a USD file: overwrites the stage's own file when no path is given, or saves a copy to the specified path.

Instructions

Write the open stage's root layer to a USD file: back to the stage's own file when file_path is empty, or as a copy at file_path.

Without file_path it overwrites the file the stage was opened from, and fails for a stage never saved, such as new_scene's. With file_path it overwrites any file there, and the stage stays tied to its own file, or to none; but another file the open stage has loaded (a sublayer, a referenced or payload file) is an error, since writing it would replace a file the open scene is made of: name another path. The stage's own file, by any name, is a save. Only the root layer is written: sublayers and referenced files stay as they are, still referenced, and Kit's session layer stays out, so the answer names the variant selections it holds, which set_variant_selection writes there by default. For one self-contained file, use flatten_usd; for one prim's subtree, export_prim_as_file.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "save_scene"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_pathNoThe USD file to write, on Kit's machine, but never another file the open stage has loaded; empty overwrites the stage's own file

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.2.3
    • changedInput schema / properties / file_path / description
      Previous value: -"The USD file to write; empty overwrites the stage's own file"New value: +"The USD file to write, on Kit's machine, but never another file the open stage has loaded; empty overwrites the stage's own file"
  2. First observedv0.2.2

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and openWorldHint=false, and the description goes further by saying exactly what is overwritten, which files may not be targeted, and that only the root layer is written (sublayers/references untouched, session layer excluded). The remaining gap is that the variant-selection remark in the return discussion is hard to parse, but behavior around destruction and failure is otherwise well disclosed.

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

Conciseness3/5

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

The core behavior is front-loaded in the first sentence, but the following paragraph is a dense run-on with stacked clauses (session layer, variant selections, set_variant_selection default) that a reader must untangle. Content mostly earns its place, yet the phrasing could be split into shorter, ordered statements.

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

Completeness5/5

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

For a one-parameter tool with an output schema, the description covers prerequisites, overwrite semantics, error conditions, scope of write, and alternatives. Nothing an agent needs to invoke it safely is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so a 3 would be the floor, but the description adds real semantics beyond the schema: empty means overwrite the stage's own file, an explicit path must not name a loaded sublayer/reference, and the path is on Kit's machine. That is meaningful added meaning for the single optional parameter.

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?

States a concrete verb and resource ('Write the open stage's root layer to a USD file') and immediately splits the two behavioral modes (empty path = save in place, path = copy). It also names the siblings it is not (flatten_usd, export_prim_as_file), so an agent can distinguish it without reading schemas.

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

Usage Guidelines5/5

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

Explicitly covers when to use each mode, the failure case for an unsaved stage ('fails for a stage never saved, such as new_scene's'), the error case for loaded sublayer/reference files, and routes to alternatives for whole-file and per-prim exports.

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