Skip to main content
Glama

Begin changeset

begin_changeset

Stage RPG Maker MV edits in memory as one transactional batch so nothing writes to disk until committed. Group related changes, review them safely, then commit all or nothing.

Instructions

Start a transactional batch of edits. While a changeset is open, every edit tool stages its result in memory: nothing is written to disk until commit_changeset, and all reads (get_map, get_record, list_plugins, ...) reflect the staged edits. Commit writes every staged file in one step (all or nothing) and can be rolled back later with undo_changeset; discard_changeset drops the staged edits. Only one changeset can be open at a time; restore_backup is refused while one is open and set_project discards it. Playtests read from disk, so they only see committed edits. The RPG Maker editor must stay closed while the server edits the project.

Input Schema

NameRequiredDescriptionDefault
labelYesShort description of the batch, e.g. 'Add the blacksmith to Town'

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.5.1

TDQS

A4.6/5.0
Behavior5/5

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

No annotations are supplied, so the description carries the full burden, and it discloses the key traits: edits are staged in memory, nothing hits disk until commit, commit is all-or-nothing, commit is reversible via undo, reads reflect staged state, and only one changeset may be open at a time. It also flags the hard environmental prerequisite that the RPG Maker editor must stay closed — exactly the kind of context an agent would otherwise get wrong. The description adds no contradicting claims.

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?

Purpose is front-loaded in the first clause, then the paragraph unfolds into staging semantics, lifecycle alternatives, and constraints in a logical order. Every sentence carries new, decision-relevant information — there is no filler or restatement of the title.

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?

For a stateful transaction-start tool with no annotations and no output schema, the description covers what an agent needs: side effects, visibility of staged data, commit/discard/undo paths, concurrency limits, and prerequisite conditions. The only minor gap is that it does not describe what the tool returns on success, though with no output schema that is a small omission.

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% and the single `label` parameter already has an example in the schema, so the description is not required to expand on it. The description never mentions `label` or how it is used, so it adds nothing beyond the schema — the baseline 3 applies.

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 first sentence, "Start a transactional batch of edits," names a specific verb and resource and immediately distinguishes this tool from the many edit siblings by framing it as a transaction boundary rather than an edit. The phrase "stages its result in memory" further pins down what "start" means operationally.

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?

It explicitly routes the agent through the whole lifecycle: commit_changeset to write, discard_changeset to drop, undo_changeset to roll back. It also states exclusions the agent could not otherwise infer — restore_backup is refused, set_project discards the changeset, and playtests see only committed edits.

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