Skip to main content
Glama

Transaction Open

transaction_open

Start an undoable transaction on the active FreeCAD document. Pair it with transaction_commit to keep changes or transaction_abort to roll back; nested transactions resolve most-recent first.

Instructions

Begin an undoable transaction on the active document. Pair with transaction_commit (keep the changes) or transaction_abort (roll back). Transactions nest — the most-recent open is committed/aborted first.

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

Input Schema

NameRequiredDescriptionDefault
labelNoTransaction
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Adds behavior beyond the annotations by disclosing that transactions are undoable, that they nest, and that the most-recent open is committed or aborted first. It does not state prerequisites such as requiring an active document or what happens if one is missing, which keeps it short of a 5.

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?

Three short sentences, front-loaded with the core action and followed by the lifecycle pairing and nesting rule. Every sentence adds useful information with no repetition.

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 zero-required-parameter transaction tool with no output schema, the description covers the essential lifecycle and nesting semantics. It could go further by explaining the label parameter or the active-document prerequisite, but no critical information is missing for routine use.

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 coverage is 50%. The workspace parameter is documented in the schema itself, but the label parameter is undocumented in both the schema and the description, and the description does not compensate for that gap. 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?

States a specific verb and resource: 'Begin an undoable transaction on the active document.' It also names the sibling tools transaction_commit and transaction_abort, making its role in the transaction lifecycle unambiguous.

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 pairs the tool with alternatives and states what each does: commit keeps changes, abort rolls back. It also specifies the nesting rule, telling the agent how multiple open transactions must be resolved.

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