Skip to main content
Glama

Get a render

get_render
Read-only

Returns the current state of a render: status (queued, rendering, succeeded or failed), download_url with expires_at, page_count, units and error, and the picture of a finished image render up to 2 MB. Use it to follow a render started with wait false, or to get a fresh link once the old one has expired; render, convert_to_pdf and the PDF tools already return this for the render they just made. Read-only and free; an unknown id returns an error.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
idYesrnd_ id of the render, as render or convert_to_pdf returned it

Output Schema

NameRequiredDescriptionDefault
idYesrnd_ id of the render
formNoWhat fill_pdf_form did: the fields filled, those left out (unknown name or invalid value) and those whose calculation or display format no viewer ran
pdfaNoThe PDF/A verdict (PDF/A-2b or PDF/A-3b), when the template declares it
errorYesWhy a failed render failed
unitsYesUnits the render counted
outputNoThe format of the file: pdf, png, jpg, webp, docx or pptx, or zip for the several files of split_pdf and pdf_to_image
statusYes
einvoiceNoThe e-invoice report, when the render made one
templateYesThe template and version rendered; null for html and conversions
expires_atYesWhen download_url stops working; get_render issues a fresh one
page_countYes
environmentYes
download_urlYesSigned link to the file; null until the render succeeded
accessibilityNoThe PDF/UA-1 verdict, when the template declares it

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / form
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "What fill_pdf_form did: the fields filled, those left out (unknown name or invalid value) and those whose calculation or display format no viewer ran",
      +  "properties": {
      +    "filled": {
      +      "type": "number"
      +    },
      +    "skipped": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "field": {
      +            "type": "string"
      +          },
      +          "reason": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "field",
      +          "reason"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "warnings": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "code": {
      +            "type": "string"
      +          },
      +          "field": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "field",
      +          "code"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "xfa_removed": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "filled",
      +    "skipped",
      +    "warnings",
      +    "xfa_removed"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / output
      Added value: +{
      +  "description": "The format of the file: pdf, png, jpg, webp, docx or pptx, or zip for the several files of split_pdf and pdf_to_image",
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • addedOutput schema / properties / pdfa
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "The PDF/A verdict (PDF/A-2b or PDF/A-3b), when the template declares it",
      +  "propertyNames": {
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover read-only and non-destructive, so the bar is lower, and the description still adds real context: the tool is free, an unknown id returns an error, and the inline picture is capped at 2 MB. The main gap is that it repeats return fields the output schema already declares instead of, say, polling/caching behavior.

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?

Front-loaded with the resource and its state, then usage, then cost/safety caveats — a sensible order. The field enumeration is somewhat redundant with the output schema and lengthens an already dense passage, but no sentence is wasted outright.

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 needn't be spelled out, yet the description covers status transitions, link expiry, error on unknown id, and size limits — more than enough for a single-parameter read tool. Only polling cadence or rate-limit expectations are absent, which is minor.

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 100% and the single id parameter is already documented as an "rnd_ id ... as render or convert_to_pdf returned it." The description only adds that an unknown id errors, which is useful but marginal; baseline 3 applies when the schema does the heavy lifting.

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 ("Returns the current state of a render") and enumerates the payload: status values, download_url with expires_at, page_count, units, error, and the 2 MB image preview. It also distinguishes itself from siblings by noting that render, convert_to_pdf and the PDF tools already return this state for their own output.

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

Usage Guidelines5/5

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

Explicit when-to-use: follow a render started with wait=false, or obtain a fresh download link after expiry. Explicit when-not: don't call it right after render/convert_to_pdf/PDF tools, since those already return this. Nothing about selection is left to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources