Skip to main content
Glama

inkbolt_session_dry_run

Read-onlyIdempotent

Simulate any session action on the expected head without modifying the database; review the content-bound proposal, receipt, and diffs, then commit via session.apply_proposal.

Instructions

Evaluate any session action on the expected head without changing the database. Returns a content-bound proposal, predicted receipt, structural differences and optional PNG/pixel comparison. Use session.apply_proposal with the same action to commit after review.

Input Schema

NameRequiredDescriptionDefault
actionYes
controlNo
optionsNo
request_idYes
session_idYes
session_rootNoRuntime path relative to the selected workspace, or an absolute path inside it. Omitted session, receipt, job, image/font store and output roots use documented workspace defaults; explicit null retains optional-root semantics.
response_formatNoJSON/Markdown include a metadata envelope in text. Structured/preview use summary text. All formats send PNG bytes once with payload references.json
expected_revisionYes

Output Schema

NameRequiredDescriptionDefault
okYes
errorNo
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely new behavioral context: it returns a content-bound proposal, predicted receipt, structural differences, and optional PNG/pixel comparison, which tells the agent what a dry run produces even though an output schema exists.

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?

Two tight sentences, front-loaded with the core purpose and the non-mutation guarantee, followed by the return payload and the commit pointer. Every clause carries information and nothing is wasted.

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

Completeness3/5

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

For a complex 8-parameter tool with a deferred action schema (variant resolved via schema.lookup), the description covers purpose, output shape and workflow but leaves concurrency/optimistic-locking semantics (expected_revision) and the action variants unexplained. Adequate as a minimum, but not fully proportioned to the tool's complexity.

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

Parameters2/5

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

Schema description coverage is only 25%, so the description must compensate for undocumented parameters, but it does not. It hints at options.preview/compare_pixels via 'optional PNG/pixel comparison', yet the required expected_revision, session_id, request_id and the multi-variant action union receive no explanation in the description.

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 ('Evaluate any session action on the expected head') plus the crucial differentiating property ('without changing the database'). It also names the sibling that performs the real commit (session.apply_proposal), so an agent can distinguish dry-run from apply without opening either schema.

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?

Explicitly frames the preview-then-commit workflow ('Use session.apply_proposal with the same action to commit after review'), which is real when-to-use guidance pointing at an alternative. It stops short of covering the broader sibling set (session_apply, session_diff, run) or stating when a dry run is unnecessary.

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