Skip to main content
Glama

begin_model_transaction

Start a transaction to batch multiple model changes together, applying them all at once upon commit or discarding on rollback.

Instructions

Open a write-transaction on the session's model: subsequent model tools accumulate TOM changes WITHOUT SaveChanges until commit_model_transaction applies them all in one SaveChanges (rollback_model_transaction discards them). Refreshes requested inside the transaction run at commit. One transaction per session; queries against the engine see the pre-transaction state until commit.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sessionIdYes
Behavior5/5

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

With no annotations, the description carries the full burden and does exceptionally well. It discloses that changes accumulate without SaveChanges, refreshes run at commit, only one transaction is allowed per session, and reads see the pre-transaction state until commit. These are exactly the non-obvious operational details an agent needs to use the tool safely.

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?

The description is a single, dense sentence that front-loads the primary action and then efficiently delivers lifecycle semantics. Every clause adds value—no redundancy, no filler—and the semicolon-separated structure keeps related facts together.

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 transaction-control tool, the description covers essential context: save timing, rollback, refresh behavior, and concurrency constraint. It does not specify the return value or error handling if a transaction is already open, but given the simplicity of the operation and absence of an output schema, these are minor gaps rather than critical omissions.

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?

The schema provides zero descriptions, and the tool description does not explicitly mention the sessionId parameter. However, the parameter name is self-explanatory, and the description references 'the session's model,' which clarifies the parameter's role. The description adds some context about the session but omits format or source details for sessionId.

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 description clearly states that the tool opens a write-transaction on the session's model, and it distinguishes itself from sibling tools like commit_model_transaction and rollback_model_transaction by explaining the accumulation and deferred save behavior. The verb 'open' and resource 'write-transaction' make the function unambiguous.

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

Usage Guidelines4/5

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

The description explicitly positions this tool as the start of a transaction and names the commit and rollback counterparts, giving the agent a clear sense of the intended workflow. It also notes the one-transaction-per-session constraint. However, it does not explicitly state when to avoid using it (e.g., for a single change) or compare it to non-transactional model-editing workflows.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/cyphonica/powerbi-pbix-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server