Skip to content

doc_render

DocumentsRead-only

A picture of a document as it exports: an image with its background and frame, a video's frame at ms (edited time, cuts removed), an audio recording's edited track as a waveform (seams between regions marked, the trimmed-off parts dimmed), a scancode, a font's specimen sheet. With no id, the item open in an editor, else the gallery's current item; the result says which (id, doc_type) and whether it drew the open editor or the saved file. For an image, scale (render pixels per picture pixel) and picture_at (where the picture's top-left is in the render) relate the two; or pass coords: "render" to doc_read / doc_edit to work in the render's pixels.

Available at every access level, including a client that sent X-Access-Level: readonly.

Parameters

NameTypeRequiredDescription
idstringnoThe item's id.
pathstringnoOr its path or name.
msintegernoFor a video: the moment, in ms of the edited video (default 0).
pageintegernoA multi-page image's page (1 is the first; default the one on screen).
max_dimensionintegernoThe longest side, in pixels (default: what this model reads best).

Example

A JSON-RPC call to POST http://localhost:21516/mcp with the bearer token, filling in the required parameters:

{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "doc_render",
"arguments": {}
}
}

See the MCP server overview for how to connect a client and where the token lives.