Skip to main content
Glama

inkbolt_session_publish

Idempotent

Publish a document or artboard from a known revision create-only, without adding an undo step. Add an optional receipt to recover prepared output and return the original result on retry.

Instructions

Capture the expected current revision and publish its document or artboard create-only without adding an undo step. Optional receipt:{receipt_root,request_id} saves prepared output for recovery and returns the original result on retry even after the source session advances or disappears. New exports retain exact-head checks. Durable receipt backend currently requires Windows.

Input Schema

NameRequiredDescriptionDefault
outputYes
controlNo
receiptNoOptional durable receipt; retries do not recapture an advanced session.
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

A3.5/5.0
Behavior4/5

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

Adds substantial behavior beyond the annotations: create-only semantics, no undo step, exact-head revision checks, receipt retry returning the original result even after the session advances/disappears, and a Windows-only durable backend constraint. It aligns with idempotentHint=true and destructiveHint=false; only the lack of auth/permission context keeps it from 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.

Conciseness4/5

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

Four sentences, front-loaded with the core publish action, then the receipt recovery semantics, then the platform caveat. Dense technical vocabulary but no wasted filler.

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?

An output schema exists, so return values need not be documented here, and the description covers the distinctive write/retry/platform behavior well. Minor incompleteness on the report/output parameter shape is largely handled by the schema.

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 43%, so the description should carry more weight. It clarifies receipt:{receipt_root,request_id} and the expected-revision capture, which adds real meaning, but leaves output, control, session_id, and session_root unaddressed, so the coverage gap is only partly compensated.

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

Purpose4/5

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

States a specific verb and resource: 'publish its document or artboard create-only without adding an undo step.' This is clear and somewhat differentiating from siblings like inkbolt_session_apply, though it does not explicitly name an alternative. An agent can tell it publishes prepared output rather than editing the session.

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

Usage Guidelines2/5

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

There is no explicit guidance on when to choose this over inkbolt_session_apply, inkbolt_session_apply_proposal, or inkbolt_session_dry_run. The receipt sentence describes a conditional behavior but not the overall when-to-use decision, leaving routing to inference.

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