Skip to main content
Glama

begin_transaction

Destructive

Starts an undoable transaction grouping all subsequent edits into a single undo entry. Returns an index required by end or cancel operations for atomic rollback.

Instructions

Open one undoable transaction so a whole batch of edits collapses into a SINGLE undo entry: every Modify() between this and end_transaction joins it, and cancel_transaction rolls the lot back without leaving anything on the stack. Use it to make a multi-step edit atomically reversible; the returned transaction_index is what end_transaction / cancel_transaction need. already_open:true means one was already running -- transactions do not nest here.

Returns: { description: string, transaction_index: int, already_open: bool, undo_count: int }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
descriptionNoLabel shown in the editor's undo history (e.g. 'MCP: retag turrets'). Make it recognisable; it is what get_transaction_history and next_undo report.
primary_object_pathNoOptional object path recorded as the transaction's PrimaryObject, so the undo entry is attributable to one asset/actor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare destructive=true and idempotent=false, but the description adds non-obvious behavior: every Modify() between begin and end joins the transaction, cancel_transaction rolls the lot back without leaving anything on the stack, and transactions do not nest. It also discloses returned fields that help the agent reason about state.

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?

Front-loads the purpose and effect, then covers lifecycle, non-nesting behavior, and return shape in focused sentences. The return block earns its place because no output schema exists, and no sentence is wasted.

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?

Without an output schema, the description supplies the return shape and key semantics for transaction_index, already_open, and undo_count. Combined with lifecycle guidance and the non-nesting warning, it is complete enough for correct invocation and closing.

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 schema already documents both optional parameters thoroughly, so the baseline is 3. The description does not add parameter-level syntax, constraints, or meaning beyond what the schema provides.

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 action (open one undoable transaction) and its main effect (a batch of edits collapses into a single undo entry). It explicitly names end_transaction and cancel_transaction, so the agent can distinguish this sibling from related closing/abort tools.

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?

Says exactly when to use it: to make a multi-step edit atomically reversible. It also explains the lifecycle via end_transaction and cancel_transaction and warns that transactions do not nest, giving clear guidance against re-entry when already_open is true.

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

Deploy Server

Other Tools