Transaction Start

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

Goes well beyond the annotations by clarifying that starting a transaction does not write source files, that only one workspace may own an active transaction, and that ownership must be coordinated when the workspace may be in use elsewhere. It also explains the lifecycle handoff to preview, commit, or rollback.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose and lifecycle are front-loaded, followed by constraints and alternatives. The length is largely justified by the transactional complexity, though the final advisory sentence about keeping transactions focused and reviewing previews is slightly less essential.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained in detail. The description covers the important missing context: prerequisites, workspace ownership, non-writing behavior at start, and the required commit or rollback follow-up.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the single optional workspace object is already documented in the schema. The description alludes to workspace ownership and snapshot context but does not add parameter syntax or format details beyond what the schema provides, so the baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: starts an isolated staged transaction from the loaded workspace snapshot, and returns transaction identity and revision zero. It clearly distinguishes this preparatory operation from transaction-commit and transaction-rollback.

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

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

Explicitly says to use this before rename-symbol, format-document, or mutating code actions. It also gives alternatives and prerequisites: commit or roll back existing work first, reload an out-of-date workspace, and check workspace-status before mutating a workspace that may be in use elsewhere.

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