mcp-for-maya

Overview Schema Source Related Servers Discussions Admin

Scene Checkpoint

scene_checkpoint

Save a self-contained Maya scene snapshot to a checkpoints folder for later rollback; name is required for untitled scenes and overwrite can preserve old files.

Instructions

Save a real scene snapshot (exportAll of in-memory state).

Boundary: Disambiguated from scene_checkpoint_list (enumerate the checkpoints already written) and scene_rollback (open one and rebind the scene to it) — scene_checkpoint is the write half.

Writes a self-contained .ma into a checkpoints/ directory next to the scene file. On untitled (never-saved) scenes an explicit name is required and produces an ad-hoc snapshot under the Maya workspace — returned with original_file_status="no_original_file" and scene_rebound_to=null. Same-name checkpoints are rejected unless overwrite=True (the old file is preserved via rename).

Honest bounds: the snapshot contains no undo history — after scene_rollback, call scene_snapshot to rebuild context. References are flattened (self-contained, no write-back). Assumes one scene file per session.

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": "scene_checkpoint"
  }
}

Input Schema

Name	Required	Description
`name`	No	Checkpoint name (^[A-Za-z0-9_-]+$). Required on untitled scenes.
`overwrite`	No	Replace a same-name checkpoint, preserving the old file.
`session_key`	No	Maya session key.

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.4.1Sep 30, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations only declare the generic safety profile (readOnly=false, destructive=false, idempotent=false); the description adds the substantive behavior: writes a self-contained .ma into a checkpoints/ directory, rejects same-name checkpoints unless overwrite=True and preserves the old file via rename, and flags the untitled-scene fallback. The 'Honest bounds' paragraph discloses the two real caveats (no undo history, flattened references) that no annotation covers.

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?

Front-loaded with the core action, then cleanly partitioned into Boundary / Behavior / Honest bounds, so an agent can skim the parts it needs. It is on the long side, but nearly every sentence carries distinct information; only the 'assumes one scene file per session' line feels like a marginal addendum.

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?

An output schema exists, yet the description still names the key return fields (original_file_status="no_original_file", scene_rebound_to=null) for the untitled branch, tying the call to its outcome. Between description, 100%-covered schema, and output schema, an agent has everything needed to invoke this correctly.

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 the baseline is 3, but the description adds genuine meaning: it explains why 'name' is conditionally required (untitled scenes) and that overwrite preserves rather than discards the old file. It stops short of restating the name regex, which the schema already covers.

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 specific verb+resource: 'Save a real scene snapshot (exportAll of in-memory state)'. It explicitly names the two closest siblings (scene_checkpoint_list, scene_rollback) and positions itself as 'the write half', so an agent can distinguish it without opening any schema.

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?

Provides an explicit 'Boundary' section routing the agent to scene_checkpoint_list for enumeration and scene_rollback for restoration. It also states the untitled-scene case and the overwrite=True condition, leaving nothing to inference.

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