Skip to main content
Glama

inkbolt_document_render

Read-onlyIdempotent

Render a bounded document snapshot as straight RGBA8 hex pixels for downstream image use. Supply asset_root and font_root when stored resources are referenced.

Instructions

Render a bounded snapshot into straight RGBA8 hex pixels. Supply asset_root and font_root when stored resources are referenced.

Input Schema

NameRequiredDescriptionDefault
scaleNo
controlNo
documentYesInline snapshot, exact saved session revision, or snapshot file pinned by SHA-256. Saved session resource bindings are inherited unless overridden; files use explicit or workspace roots.
font_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.
asset_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.
render_optionsNo
response_formatNoJSON/Markdown include a metadata envelope in text. Structured/preview use summary text. All formats send PNG bytes once with payload references.json

Output Schema

NameRequiredDescriptionDefault
okYes
errorNo
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so the safety profile is fully covered. The description adds the output pixel format and the resource-root dependency rule, but says nothing about size bounds of a 'bounded snapshot', timeout/cancellation behaviour, or cost/limits.

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?

Two compact sentences with the core action front-loaded and no filler. The second sentence is conditional guidance rather than padding, though 'bounded' is left undefined.

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?

With an output schema present, return values need not be explained, and annotations cover safety. Still, for a 7-parameter render tool the description omits what 'bounded' means, whether output is returned inline or as a reference, and how it differs from the preview sibling.

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 57% and the schema itself carries long normative text for document, session_root, cancel_file, asset_root and font_root. The description only restates the asset_root/font_root condition, adding no syntax, format or default that the schema does not already provide.

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?

The description gives a specific verb (Render), a specific input (a bounded snapshot) and a precise output format (straight RGBA8 hex pixels), which is more than a tautology. It does not however name or contrast with the obvious siblings such as inkbolt_document_preview or inkbolt_document_inspect_page, so an agent must still infer where this fits.

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 statement of when to choose this tool over inkbolt_document_preview, inkbolt_run, or the inspect variants. The only conditional ('Supply asset_root and font_root when stored resources are referenced') is parameter-level advice, not usage routing or exclusions.

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