Dynamic Document API turns templates plus JSON data, HTML or Markdown into PDFs, images and e-invoices. To render from a template: call `list_templates` to find its id, `get_template_schema` to learn the data it expects, then `render_pdf_from_template` or `render_image_from_template`. To check an e-invoice someone sent (a ZUGFeRD / Factur-X PDF or an XRechnung XML), call `validate_einvoice`. Renders run in test mode unless a call passes `test: false`: test files carry a TEST watermark and are not billed. Pass `test: false` only when the user wants the final document. Results carry signed download URLs that expire; `get_render` returns fresh ones.
Discoverability
1 pass · 1 partial1 passed · 1 partial25/100
Client listings and public setup information.
mcp.json or server-card.json
Either mcp.json or an MCP Server Card declaring this endpoint passes.
No matching mcp.json manifest or MCP Server Card was found at the checked URLs.
The title clearly communicates the tool’s action and subject. Keep it concise.
Description98/100
List the published templates of the connected workspace: id, name, type and live version. Use it to find the `template_id` for a document the user describes; skip it when you already have the id. PDF templates (`pdf_code`, `pdf_markdown`) go to `render_pdf_from_template`, image templates (`image_canvas`) to `render_image_from_template`; `get_template_schema` returns the data a template expects. Returns 50 templates per page unless `limit` says otherwise; pass `next_cursor` as `cursor` while `has_more`. Not billed. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs88/100
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
type
Only return templates of this type, e.g. `image_canvas` for image templates.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
query
Part of a template name, case-insensitive.
Clear enough to supply this argument.
limit
Page size, 1-100 (default 50).
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
The title clearly communicates the tool’s action and subject. Keep it concise.
Description98/100
Get the `data` a template expects before rendering it: its JSON Schema, every field as a dotted path with type and required flag, an image template's dynamic properties, an example payload and `einvoice_default` (the template's default ZUGFeRD / Factur-X e-invoice, or null). One call per template is enough; the id comes from `list_templates` or from the user. `fields` and `example_data` show the shape of `data`, and `render_pdf_from_template` and `render_image_from_template` reject data that breaks the schema. `render_pdf_from_html` and `render_pdf_from_markdown` take no template and need no schema. When `einvoice_default` is set, every PDF render embeds that e-invoice, so `data` must also hold the invoice object at its `invoice_path` (on Free and Starter it is skipped with the warning `einvoice_skipped_plan`); `render_pdf_from_template` can replace it or turn it off. Not billed. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs75/100
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
template_id
Template id from `list_templates`, e.g. `tpl_01J9ZK…`.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
Annotations100/100
All four behavior hints are declared.
{
"title": "Get a template's data schema",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
Output schema79/100
The output schema explains the structured result.
View output schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"fields",
"dynamic_properties"
],
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"path",
"type",
"required",
"line_item"
],
"properties": {
"enum": {
"type": "array",
"items": {},
"description": "The only values the field accepts."
},
"path": {
"type": "string",
"description": "Dotted path into `data`, e.g. `customer.name`, or `items[].price` inside an array."
},
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"line_item": {
"type": "boolean",
"description": "The field sits inside an array of rows, such as invoice lines."
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "Every field of the schema, flattened."
},
"schema": {
"type": "object",
"description": "The JSON Schema of `data`.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"version": {
"type": [
"number",
"null"
],
"description": "The template version the schema belongs to."
},
"declared": {
"type": "boolean",
"description": "False when the schema was inferred from the template source rather than declared."
},
"template_id": {
"type": "string"
},
"example_data": {
"description": "A `data` payload that matches the schema, to fill in."
},
"einvoice_default": {
"anyOf": [
{
"type": "object",
"required": [
"profile",
"invoice_path"
],
"properties": {
"profile": {
"type": "string"
},
"invoice_path": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The template's default e-invoice, or null. When set, every PDF render embeds a ZUGFeRD / Factur-X e-invoice read from `data` at `invoice_path`, unless the render passes `einvoice` (replace) or `einvoice: null` (plain PDF)."
},
"dynamic_properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"type"
],
"properties": {
"key": {
"type": "string",
"description": "Dotted `data` key of an image template, e.g. `title.text` or `hero.src`."
},
"type": {
"type": "string"
},
"default": {},
"max_length": {
"type": "number"
}
},
"additionalProperties": false
},
"description": "What `data` can set on an image (`image_canvas`) template; empty for PDF templates."
}
},
"additionalProperties": false
}
Original tool metadata
{
"name": "get_template_schema",
"title": "Get a template's data schema",
"description": "Get the `data` a template expects before rendering it: its JSON Schema, every field as a dotted path with type and required flag, an image template's dynamic properties, an example payload and `einvoice_default` (the template's default ZUGFeRD / Factur-X e-invoice, or null). One call per template is enough; the id comes from `list_templates` or from the user. `fields` and `example_data` show the shape of `data`, and `render_pdf_from_template` and `render_image_from_template` reject data that breaks the schema. `render_pdf_from_html` and `render_pdf_from_markdown` take no template and need no schema. When `einvoice_default` is set, every PDF render embeds that e-invoice, so `data` must also hold the invoice object at its `invoice_path` (on Free and Starter it is skipped with the warning `einvoice_skipped_plan`); `render_pdf_from_template` can replace it or turn it off. Not billed. Limited to 60 tool calls a minute per connection, shared by all tools.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"template_id": {
"type": "string",
"description": "Template id from `list_templates`, e.g. `tpl_01J9ZK…`."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"fields",
"dynamic_properties"
],
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"path",
"type",
"required",
"line_item"
],
"properties": {
"enum": {
"type": "array",
"items": {},
"description": "The only values the field accepts."
},
"path": {
"type": "string",
"description": "Dotted path into `data`, e.g. `customer.name`, or `items[].price` inside an array."
},
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"line_item": {
"type": "boolean",
"description": "The field sits inside an array of rows, such as invoice lines."
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "Every field of the schema, flattened."
},
"schema": {
"type": "object",
"description": "The JSON Schema of `data`.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"version": {
"type": [
"number",
"null"
],
"description": "The template version the schema belongs to."
},
"declared": {
"type": "boolean",
"description": "False when the schema was inferred from the template source rather than declared."
},
"template_id": {
"type": "string"
},
"example_data": {
"description": "A `data` payload that matches the schema, to fill in."
},
"einvoice_default": {
"anyOf": [
{
"type": "object",
"required": [
"profile",
"invoice_path"
],
"properties": {
"profile": {
"type": "string"
},
"invoice_path": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The template's default e-invoice, or null. When set, every PDF render embeds a ZUGFeRD / Factur-X e-invoice read from `data` at `invoice_path`, unless the render passes `einvoice` (replace) or `einvoice: null` (plain PDF)."
},
"dynamic_properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"type"
],
"properties": {
"key": {
"type": "string",
"description": "Dotted `data` key of an image template, e.g. `title.text` or `hero.src`."
},
"type": {
"type": "string"
},
"default": {},
"max_length": {
"type": "number"
}
},
"additionalProperties": false
},
"description": "What `data` can set on an image (`image_canvas`) template; empty for PDF templates."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Get a template's data schema",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}
The title clearly communicates the tool’s action and subject. Keep it concise.
Description99/100
Render a PDF from a saved template of the workspace plus JSON `data`. Use it when a template exists for the document (invoices, quotes, certificates, recurring reports); otherwise write the layout with `render_pdf_from_html` or turn text into a PDF with `render_pdf_from_markdown`, and use `render_image_from_template` for images. `template_id` comes from `list_templates` and the shape of `data` from `get_template_schema`; data that breaks the schema fails with each wrong field's path. Waits up to 25 s, then returns the files with signed download URLs valid for `expires_in` (default 1 h). A slower render comes back `queued` or `processing`: `get_render` collects it, and re-signs expired links. Test mode unless you pass `test: false`: test renders are free, carry a TEST watermark and are limited per minute by plan; final ones are billed (1 render per 50 pages), failed ones are free. Pass `einvoice` for a hybrid e-invoice PDF (Factur-X / ZUGFeRD / XRechnung) that accounting software can read. A template with `einvoice_default` (from `get_template_schema`) embeds a ZUGFeRD / Factur-X e-invoice in every PDF render, a hybrid PDF/A-3b, read from `data` at its `invoice_path` (missing: 400 validation_error at /data). `einvoice` replaces that default, `einvoice: null` turns it off for a plain PDF. On plans without e-invoicing (Free, Starter) the PDF is rendered without it and carries the warning `einvoice_skipped_plan`; e-invoicing needs the Growth plan or higher. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs59/100
17 of 27 inputs have descriptions. Add descriptions to the missing inputs, including where to obtain IDs and how to supply values.
template_id
Template id from `list_templates`, e.g. `tpl_01J9ZK…`.
Clear enough to supply this argument.
data
Template data as JSON. Canvas/image templates accept dotted keys (`title.text`, `hero.src`) or the equivalent nested objects. Call `get_template_schema` first to learn the shape.
Clear enough to supply this argument.
version
Template version: `live` (default), `draft` (test keys only) or a version number.
Clear enough to supply this argument.
pdf › paper › anyOf › 0 › size
Named paper size.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
pdf › paper › anyOf › 1 › width
CSS length with units, e.g. "80mm".
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
pdf › paper › anyOf › 1 › height
CSS length with units, e.g. "200mm".
Clear enough to supply this argument.
pdf › orientation
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › top
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › right
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › bottom
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › left
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › print_background
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › scale
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › prefer_css_page_size
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › single_page
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › page_ranges
Pages to keep, e.g. "1-3,5".
Clear enough to supply this argument.
pdf › outline
Generate PDF bookmarks from h1-h6.
Clear enough to supply this argument.
pdf › tagged
Emit a tagged (accessible) PDF.
Clear enough to supply this argument.
pdf › emulate_media
Not provided
Missing description. Explain what this value means and how to supply it.
einvoice › anyOf › 0 › profile
E-invoice profile. XRECHNUNG: German public-sector buyers — needs `buyer_reference` (the Leitweg-ID), seller `contact` {name, phone, email}, seller and buyer `electronic_address`, and `payment`. EN16931: the full European standard. Factur-X / ZUGFeRD levels: MINIMUM and BASIC_WL (line items are not transmitted), BASIC, EXTENDED.
Clear enough to supply this argument.
einvoice › anyOf › 0 › invoice
The invoice as EN 16931 fields in snake_case. Required: `number`, `issue_date` (YYYY-MM-DD), `currency` (ISO 4217, e.g. EUR), `seller` and `buyer` {name, address {line1, city, postcode, country (ISO 3166 alpha-2)}}, `lines` [{quantity, price {net}, tax {category, rate}, item {name}}]. Often needed: `due_date`, `buyer_reference`, `payment_terms`, `type_code` (380 invoice, 381 credit note), `seller.vat_id`, `electronic_address` {id, scheme: EM for e-mail, 0204 for a Leitweg-ID}, `payment` {means_code: "58" SEPA credit transfer, credit_transfers [{account_id: IBAN}]}, line `unit` (C62 piece, HUR hour, DAY day), `invoice_period` {start, end}. VAT categories: S standard, Z zero-rated, E exempt, AE reverse charge, K intra-EU supply, G export, O not subject to VAT (E, AE, K, G and O need `vat_exemptions` {<category>: {reason}}). Amounts are decimal strings such as "95.00". Do NOT send totals, VAT amounts or line net amounts: they are computed from the lines.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
einvoice › anyOf › 0 › invoice_path
Instead of `invoice`: dotted object keys into `data` where the invoice object is — e.g. `invoice` when data is {"invoice": {…}}. Send exactly one of `invoice` and `invoice_path`.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
filename
Output filename. Jinja is allowed, e.g. `invoice-{{ data.number }}.pdf`.
Clear enough to supply this argument.
reference
Your own identifier for this render; filterable later via the renders list.
Clear enough to supply this argument.
metadata
Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).
Clear enough to supply this argument.
test
Test mode. Test renders are free and carry a TEST watermark. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for the final document, which is billed. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test renders, a live key always final ones (`true` is refused).
Clear enough to supply this argument.
expires_in
Lifetime of the signed download URLs, in seconds (default 3600, one hour). `get_render` signs fresh ones for the same lifetime.
Clear enough to supply this argument.
Annotations100/100
All four behavior hints are declared.
{
"title": "Render a PDF from a template",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
The title clearly communicates the tool’s action and subject. Keep it concise.
Description97/100
Render a PNG, JPEG or WebP image from a saved image template (`image_canvas`) plus `data`: social and Open Graph images, banners, badges. Image templates are listed by `list_templates` (`type: image_canvas`); their dynamic properties, from `get_template_schema`, go in `data` as dotted keys such as `title.text` or `hero.src` (an image URL). A PDF comes from `render_pdf_from_template`. Waits up to 25 s, then returns the files with signed download URLs valid for `expires_in` (default 1 h). A slower render comes back `queued` or `processing`: `get_render` collects it, and re-signs expired links. Test mode unless you pass `test: false`: test renders are free, carry a TEST watermark and are limited per minute by plan; final ones are billed (1 render per image), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs56/100
12 of 18 inputs have descriptions. Add descriptions to the missing inputs, including where to obtain IDs and how to supply values.
template_id
Image template id from `list_templates`, e.g. `tpl_01J9ZK…`.
Clear enough to supply this argument.
data
Template data as JSON. Canvas/image templates accept dotted keys (`title.text`, `hero.src`) or the equivalent nested objects. Call `get_template_schema` first to learn the shape.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
format
Output format (default png).
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
version
Template version: `live` (default), `draft` (test keys only) or a version number.
Clear enough to supply this argument.
image › scale
Device scale factor (retina).
Clear enough to supply this argument.
image › width
Not provided
Missing description. Explain what this value means and how to supply it.
image › height
Not provided
Missing description. Explain what this value means and how to supply it.
image › fit
Not provided
Missing description. Explain what this value means and how to supply it.
image › transparent
PNG/WebP only.
Clear enough to supply this argument.
image › full_page
Screenshots: capture the whole scrollable page.
Explain the meaning of this value, not just its name.
image › format_options › quality
Not provided
Missing description. Explain what this value means and how to supply it.
image › format_options › progressive
Not provided
Missing description. Explain what this value means and how to supply it.
image › format_options › lossless
Not provided
Missing description. Explain what this value means and how to supply it.
filename
Output filename. Jinja is allowed, e.g. `invoice-{{ data.number }}.pdf`.
Clear enough to supply this argument.
reference
Your own identifier for this render; filterable later via the renders list.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
metadata
Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
test
Test mode. Test renders are free and carry a TEST watermark. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for the final document, which is billed. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test renders, a live key always final ones (`true` is refused).
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
expires_in
Lifetime of the signed download URLs, in seconds (default 3600, one hour). `get_render` signs fresh ones for the same lifetime.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
Annotations100/100
All four behavior hints are declared.
{
"title": "Render an image from a template",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
The title clearly communicates the tool’s action and subject. Keep it concise.
Description98/100
Render a PDF from HTML and CSS you write, in headless Chromium. Use it when no saved template fits and the layout matters: letters, styled tables, one-off documents. For a saved template use `render_pdf_from_template`; for a text report without layout work `render_pdf_from_markdown` is shorter. With `data`, the HTML is a Jinja template (`{{ name }}`, `{% for row in rows %}`). Remote images and fonts must be public URLs; load web fonts with <link> tags in `head`. Waits up to 25 s, then returns the files with signed download URLs valid for `expires_in` (default 1 h). A slower render comes back `queued` or `processing`: `get_render` collects it, and re-signs expired links. Test mode unless you pass `test: false`: test renders are free, carry a TEST watermark and are limited per minute by plan; final ones are billed (1 render per 50 pages), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs59/100
15 of 25 inputs have descriptions. Add descriptions to the missing inputs, including where to obtain IDs and how to supply values.
html
The HTML to render: a full document or just the <body> content.
Clear enough to supply this argument.
css
CSS injected as a <style> block in <head>.
Clear enough to supply this argument.
head
Raw <head> contents (link/meta/script), appended after `css`.
Clear enough to supply this argument.
data
Jinja variables for the HTML; when present, the HTML is rendered as a Jinja template first.
Clear enough to supply this argument.
pdf › paper › anyOf › 0 › size
Named paper size.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
pdf › paper › anyOf › 1 › width
CSS length with units, e.g. "80mm".
Clear enough to supply this argument.
pdf › paper › anyOf › 1 › height
CSS length with units, e.g. "200mm".
Clear enough to supply this argument.
pdf › orientation
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › top
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › right
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › bottom
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › left
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › print_background
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › scale
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › prefer_css_page_size
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › single_page
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › page_ranges
Pages to keep, e.g. "1-3,5".
Clear enough to supply this argument.
pdf › outline
Generate PDF bookmarks from h1-h6.
Clear enough to supply this argument.
pdf › tagged
Emit a tagged (accessible) PDF.
Clear enough to supply this argument.
pdf › emulate_media
Not provided
Missing description. Explain what this value means and how to supply it.
filename
Output filename. Jinja is allowed, e.g. `invoice-{{ data.number }}.pdf`.
Clear enough to supply this argument.
reference
Your own identifier for this render; filterable later via the renders list.
Clear enough to supply this argument.
metadata
Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).
Clear enough to supply this argument.
test
Test mode. Test renders are free and carry a TEST watermark. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for the final document, which is billed. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test renders, a live key always final ones (`true` is refused).
Clear enough to supply this argument.
expires_in
Lifetime of the signed download URLs, in seconds (default 3600, one hour). `get_render` signs fresh ones for the same lifetime.
Clear enough to supply this argument.
Annotations100/100
All four behavior hints are declared.
{
"title": "Render a PDF from HTML",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
The title clearly communicates the tool’s action and subject. Keep it concise.
Description98/100
Render a PDF from Markdown with a built-in theme: the quickest way to turn a report, summary or notes you have written into a clean document, with no layout work. Supports tables, task lists, footnotes and strikethrough; raw HTML is not rendered. For a designed layout use `render_pdf_from_html`, for a saved template `render_pdf_from_template`. Waits up to 25 s, then returns the files with signed download URLs valid for `expires_in` (default 1 h). A slower render comes back `queued` or `processing`: `get_render` collects it, and re-signs expired links. Test mode unless you pass `test: false`: test renders are free, carry a TEST watermark and are limited per minute by plan; final ones are billed (1 render per 50 pages), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs53/100
15 of 25 inputs have descriptions. Add descriptions to the missing inputs, including where to obtain IDs and how to supply values.
markdown
The Markdown source (GitHub-style tables, task lists and footnotes work).
Clear enough to supply this argument.
theme
Built-in stylesheet (default `default`); `none` leaves only your `css`.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
css
Extra CSS layered on top of the theme.
Explain the meaning of this value, not just its name.
data
Jinja variables for the Markdown, e.g. `{{ customer }}`.
Clear enough to supply this argument.
pdf › paper › anyOf › 0 › size
Named paper size.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
pdf › paper › anyOf › 1 › width
CSS length with units, e.g. "80mm".
Clear enough to supply this argument.
pdf › paper › anyOf › 1 › height
CSS length with units, e.g. "200mm".
Clear enough to supply this argument.
pdf › orientation
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › top
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › right
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › bottom
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › margin › left
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › print_background
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › scale
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › prefer_css_page_size
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › single_page
Not provided
Missing description. Explain what this value means and how to supply it.
pdf › page_ranges
Pages to keep, e.g. "1-3,5".
Clear enough to supply this argument.
pdf › outline
Generate PDF bookmarks from h1-h6.
Clear enough to supply this argument.
pdf › tagged
Emit a tagged (accessible) PDF.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
pdf › emulate_media
Not provided
Missing description. Explain what this value means and how to supply it.
filename
Output filename. Jinja is allowed, e.g. `invoice-{{ data.number }}.pdf`.
Clear enough to supply this argument.
reference
Your own identifier for this render; filterable later via the renders list.
Clear enough to supply this argument.
metadata
Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).
Clear enough to supply this argument.
test
Test mode. Test renders are free and carry a TEST watermark. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for the final document, which is billed. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test renders, a live key always final ones (`true` is refused).
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
expires_in
Lifetime of the signed download URLs, in seconds (default 3600, one hour). `get_render` signs fresh ones for the same lifetime.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
Annotations100/100
All four behavior hints are declared.
{
"title": "Render a PDF from Markdown",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
Create an e-invoice XML (XRechnung, EN 16931, Factur-X / ZUGFeRD)
Shorten the title to an action and subject; move usage details into the description.
Description99/100
Generate a standalone, validated e-invoice XML file from invoice data — e.g. an XRechnung for a German public-sector buyer, or an EN 16931 invoice for a Peppol network. To embed the invoice in a PDF instead, use `render_pdf_from_template` with `einvoice`. Returns a signed download URL for the XML (valid for `expires_in`, default 1 h) and the validator's verdict in `conformance.einvoice.status` (passed | failed | unavailable). If the data breaks a rule of the profile, the call fails and lists every problem with its field path. Needs the Growth plan or higher; on other plans the call fails with 402 `plan_feature_unavailable`. Test mode unless you pass `test: false`: test renders are free, carry a TEST note in the XML (MINIMUM has no field for it) and are limited per minute by plan; final ones are billed (1 render per XML), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs94/100
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
profile
E-invoice profile. XRECHNUNG: German public-sector buyers — needs `buyer_reference` (the Leitweg-ID), seller `contact` {name, phone, email}, seller and buyer `electronic_address`, and `payment`. EN16931: the full European standard. Factur-X / ZUGFeRD levels: MINIMUM and BASIC_WL (line items are not transmitted), BASIC, EXTENDED.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
syntax
XML syntax: `cii` (UN/CEFACT Cross Industry Invoice, the default, every profile) or `ubl` (UBL 2.1, only EN16931 and XRECHNUNG). Use `ubl` when the recipient asks for UBL, e.g. many Peppol access points.
Clear enough to supply this argument.
invoice
The invoice as EN 16931 fields in snake_case. Required: `number`, `issue_date` (YYYY-MM-DD), `currency` (ISO 4217, e.g. EUR), `seller` and `buyer` {name, address {line1, city, postcode, country (ISO 3166 alpha-2)}}, `lines` [{quantity, price {net}, tax {category, rate}, item {name}}]. Often needed: `due_date`, `buyer_reference`, `payment_terms`, `type_code` (380 invoice, 381 credit note), `seller.vat_id`, `electronic_address` {id, scheme: EM for e-mail, 0204 for a Leitweg-ID}, `payment` {means_code: "58" SEPA credit transfer, credit_transfers [{account_id: IBAN}]}, line `unit` (C62 piece, HUR hour, DAY day), `invoice_period` {start, end}. VAT categories: S standard, Z zero-rated, E exempt, AE reverse charge, K intra-EU supply, G export, O not subject to VAT (E, AE, K, G and O need `vat_exemptions` {<category>: {reason}}). Amounts are decimal strings such as "95.00". Do NOT send totals, VAT amounts or line net amounts: they are computed from the lines.
Clear enough to supply this argument.
filename
Output filename; `.xml` is enforced. Default: the invoice number.
Clear enough to supply this argument.
reference
Your own identifier for this render; filterable later via the renders list.
Clear enough to supply this argument.
metadata
Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
test
Test mode. Test renders are free and carry a TEST watermark. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for the final document, which is billed. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test renders, a live key always final ones (`true` is refused).
Clear enough to supply this argument.
expires_in
Lifetime of the signed download URLs, in seconds (default 3600, one hour). `get_render` signs fresh ones for the same lifetime.
Clear enough to supply this argument.
Annotations100/100
All four behavior hints are declared.
{
"title": "Create an e-invoice XML (XRechnung, EN 16931, Factur-X / ZUGFeRD)",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
Validate an e-invoice (XRechnung, ZUGFeRD / Factur-X, EN 16931)
The title clearly communicates the tool’s action and subject. Keep it concise.
Description99/100
Check an e-invoice someone sent: a Factur-X / ZUGFeRD PDF (or a PDF carrying `xrechnung.xml`), or an XRechnung or EN 16931 XML in CII or UBL. Use it on incoming invoices before they go to accounting, or on an XML from `create_einvoice` (its `render_id`). It creates no file; to make an e-invoice, use `create_einvoice` or `render_pdf_from_template` with `einvoice`. Every plan, Free included. The KoSIT validator checks the XML against the standard's schema and business rules; for a PDF, veraPDF checks PDF/A-3b, which Factur-X requires. Returns `valid`, what the file holds in `document` (profile, syntax, specification identifier) and the validators' reports in `conformance`, with the rules the file breaks. It also returns what the invoice states, for invalid invoices too: `invoice` (number, dates, seller, buyer, bank account, lines, with `create_einvoice`'s field names), `vat_breakdown` and `totals` (`due_payable`). A file without an e-invoice, or with one the check doesn't cover (ZUGFeRD 1.0 and 2.0, XRechnung before 3.0, Peppol BIS Billing 3.0), returns `valid: false` with a `reason`. Not checked: whether the invoice is right for tax purposes, signatures, and whether the PDF's pages match the XML. Waits up to 25 s; a slower check comes back `queued` or `processing`, and `get_render` collects it. Test mode unless you pass `test: false`: test renders are free, give the same verdict, at most 25 a day per workspace, and are limited per minute by plan; final ones are billed (1 render per verdict, valid or invalid), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs90/100
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
source › url
Public https URL of the PDF or XML.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
source › data_uri
The file itself, base64-encoded: `data:application/pdf;base64,…` for a PDF, `data:application/xml;base64,…` for an XML. At most 5 MB decoded.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
source › upload_id
A PDF or XML uploaded through the API, e.g. `upl_…`.
Clear enough to supply this argument.
source › render_id
An earlier render of this workspace, e.g. the XML of `create_einvoice` (`rnd_…`).
Clear enough to supply this argument.
source › file_id
Which PDF or XML file of `render_id` to check (default: its first).
Clear enough to supply this argument.
reference
Your own identifier for this render; filterable later via the renders list.
Clear enough to supply this argument.
metadata
Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).
Clear enough to supply this argument.
test
Test mode. Test checks are free and give the same verdict, at most 25 a day per workspace. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for a billed check. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test checks, a live key always billed ones (`true` is refused).
Clear enough to supply this argument.
Annotations100/100
All four behavior hints are declared.
{
"title": "Validate an e-invoice (XRechnung, ZUGFeRD / Factur-X, EN 16931)",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
Output schema88/100
The output schema explains the structured result.
View output schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"render_id",
"status",
"test",
"valid",
"reason",
"document",
"conformance",
"invoice",
"vat_breakdown",
"totals"
],
"properties": {
"test": {
"type": "boolean",
"description": "A free test check; false for a billed one. Both give the same verdict."
},
"pages": {
"type": [
"number",
"null"
],
"description": "Page count of a PDF; null for an XML."
},
"valid": {
"type": [
"boolean",
"null"
],
"description": "`true`: the XML passed the KoSIT validator and, for a PDF, the PDF passed PDF/A-3b (warnings don't count). `false`: it failed (see `conformance`), or the file holds no e-invoice this check covers (see `reason`). `null` while the check is still running."
},
"reason": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"enum": [
"einvoice_not_found",
"einvoice_unsupported"
],
"type": "string"
},
"message": {
"type": "string",
"description": "What was found, e.g. the specification identifier that isn't supported."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Why there is no verdict: `einvoice_not_found`, the file is no e-invoice (neither a PDF nor an XML, a PDF without an embedded invoice XML, an XML that isn't an invoice); `einvoice_unsupported`, an e-invoice this check doesn't cover (e.g. ZUGFeRD 1.0, XRechnung before 3.0, Peppol BIS Billing 3.0). `null` with a verdict."
},
"status": {
"enum": [
"queued",
"processing",
"succeeded",
"failed",
"canceled",
"expired"
],
"type": "string",
"description": "`succeeded`: the validators gave a verdict, see `valid`. `queued` / `processing`: still running, collect it with `get_render`. `failed`: the file holds no e-invoice this check covers, see `reason`."
},
"totals": {
"anyOf": [
{
"type": "object",
"required": [
"line_total",
"allowance_total",
"charge_total",
"tax_basis_total",
"tax_total",
"grand_total",
"prepaid",
"rounding",
"due_payable"
],
"properties": {
"prepaid": {
"type": [
"string",
"null"
]
},
"rounding": {
"type": [
"string",
"null"
]
},
"tax_total": {
"type": [
"string",
"null"
]
},
"line_total": {
"type": [
"string",
"null"
]
},
"due_payable": {
"type": [
"string",
"null"
],
"description": "The amount due."
},
"grand_total": {
"type": [
"string",
"null"
]
},
"charge_total": {
"type": [
"string",
"null"
]
},
"allowance_total": {
"type": [
"string",
"null"
]
},
"tax_basis_total": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The document totals as stated (not recomputed), decimal strings; null with `invoice`."
},
"invoice": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
],
"description": "What the invoice states, with the field names of `create_einvoice`'s `invoice` (`number`, `issue_date`, `due_date`, `seller`, `buyer`, `payment.credit_transfers[].account_id` for the IBAN, `lines`, …): only what the document holds, values as written. Also for invalid invoices. Null without a verdict, when the XML can't be read, and in a zero-retention workspace when `get_render` collects the check (only the answer of the call that ran it carries the data)."
},
"document": {
"anyOf": [
{
"type": "object",
"required": [
"container",
"attachment",
"syntax",
"profile",
"specification_id"
],
"properties": {
"syntax": {
"type": "string",
"description": "`cii` or `ubl`."
},
"profile": {
"type": "string",
"description": "The profile its specification identifier names: MINIMUM, BASIC_WL, BASIC, EN16931, EXTENDED or XRECHNUNG."
},
"container": {
"enum": [
"pdf",
"xml"
],
"type": "string",
"description": "`pdf`: a hybrid PDF with the XML embedded; `xml`: a standalone XML."
},
"attachment": {
"type": [
"string",
"null"
],
"description": "The embedded file's name, e.g. `factur-x.xml`; null for an XML."
},
"specification_id": {
"type": "string",
"description": "The specification identifier (BT-24) as written in the XML."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "What the check found in the file; null without a verdict."
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "Non-fatal problems of the check itself; the validators' warnings are in `conformance`."
},
"reference": {
"type": [
"string",
"null"
],
"description": "The `reference` the call passed."
},
"render_id": {
"type": [
"string",
"null"
],
"description": "Id of the check (`rnd_…`), for `get_render`."
},
"created_at": {
"type": "string"
},
"conformance": {
"anyOf": [
{
"type": "object",
"properties": {
"pdfa": {
"type": "object",
"required": [
"level",
"status",
"errors",
"warnings"
],
"properties": {
"level": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"status": {
"enum": [
"passed",
"failed",
"unavailable"
],
"type": "string"
},
"profile": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"validator": {
"type": "string"
}
},
"additionalProperties": false
},
"einvoice": {
"type": "object",
"required": [
"profile",
"syntax",
"status",
"errors",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"status": {
"enum": [
"passed",
"failed",
"unavailable"
],
"type": "string"
},
"syntax": {
"type": "string"
},
"profile": {
"type": "string"
},
"scenario": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"validator": {
"type": "string"
}
},
"additionalProperties": false
}
},
"description": "Validation report: veraPDF for PDF/A, the KoSIT validator for the e-invoice XML. `unavailable` means the validator could not be reached and the file was delivered unvalidated.",
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The reports, `status` `passed` or `failed`: the KoSIT validator's on the XML (`einvoice`) and, for a PDF, veraPDF's PDF/A-3b report on the file as received (`pdfa`). Every rule the file breaks is in `errors`."
},
"completed_at": {
"type": [
"string",
"null"
]
},
"vat_breakdown": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"category",
"rate",
"basis",
"tax",
"exemption_reason",
"exemption_reason_code"
],
"properties": {
"tax": {
"type": [
"string",
"null"
]
},
"rate": {
"type": [
"string",
"null"
]
},
"basis": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"exemption_reason": {
"type": [
"string",
"null"
]
},
"exemption_reason_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
],
"description": "The VAT breakdown as the document states it (not recomputed); null with `invoice`."
},
"billed_renders": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Renders billed for the check: 1 for a verdict, valid or invalid; 0 for test checks and failed ones."
}
},
"additionalProperties": false
}
Original tool metadata
{
"name": "validate_einvoice",
"title": "Validate an e-invoice (XRechnung, ZUGFeRD / Factur-X, EN 16931)",
"description": "Check an e-invoice someone sent: a Factur-X / ZUGFeRD PDF (or a PDF carrying `xrechnung.xml`), or an XRechnung or EN 16931 XML in CII or UBL. Use it on incoming invoices before they go to accounting, or on an XML from `create_einvoice` (its `render_id`). It creates no file; to make an e-invoice, use `create_einvoice` or `render_pdf_from_template` with `einvoice`. Every plan, Free included. The KoSIT validator checks the XML against the standard's schema and business rules; for a PDF, veraPDF checks PDF/A-3b, which Factur-X requires. Returns `valid`, what the file holds in `document` (profile, syntax, specification identifier) and the validators' reports in `conformance`, with the rules the file breaks. It also returns what the invoice states, for invalid invoices too: `invoice` (number, dates, seller, buyer, bank account, lines, with `create_einvoice`'s field names), `vat_breakdown` and `totals` (`due_payable`). A file without an e-invoice, or with one the check doesn't cover (ZUGFeRD 1.0 and 2.0, XRechnung before 3.0, Peppol BIS Billing 3.0), returns `valid: false` with a `reason`. Not checked: whether the invoice is right for tax purposes, signatures, and whether the PDF's pages match the XML. Waits up to 25 s; a slower check comes back `queued` or `processing`, and `get_render` collects it. Test mode unless you pass `test: false`: test renders are free, give the same verdict, at most 25 a day per workspace, and are limited per minute by plan; final ones are billed (1 render per verdict, valid or invalid), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"source"
],
"properties": {
"test": {
"type": "boolean",
"description": "Test mode. Test checks are free and give the same verdict, at most 25 a day per workspace. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for a billed check. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test checks, a live key always billed ones (`true` is refused)."
},
"source": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Public https URL of the PDF or XML."
},
"file_id": {
"type": "string",
"description": "Which PDF or XML file of `render_id` to check (default: its first)."
},
"data_uri": {
"type": "string",
"pattern": "^data:(application\\/pdf|application\\/xml|text\\/xml|application\\/octet-stream);base64,",
"description": "The file itself, base64-encoded: `data:application/pdf;base64,…` for a PDF, `data:application/xml;base64,…` for an XML. At most 5 MB decoded."
},
"render_id": {
"type": "string",
"description": "An earlier render of this workspace, e.g. the XML of `create_einvoice` (`rnd_…`)."
},
"upload_id": {
"type": "string",
"description": "A PDF or XML uploaded through the API, e.g. `upl_…`."
}
},
"description": "Exactly one of `url`, `data_uri`, `upload_id` or `render_id` (+ `file_id`)."
},
"metadata": {
"type": "object",
"description": "Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"reference": {
"type": "string",
"maxLength": 255,
"description": "Your own identifier for this render; filterable later via the renders list."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"render_id",
"status",
"test",
"valid",
"reason",
"document",
"conformance",
"invoice",
"vat_breakdown",
"totals"
],
"properties": {
"test": {
"type": "boolean",
"description": "A free test check; false for a billed one. Both give the same verdict."
},
"pages": {
"type": [
"number",
"null"
],
"description": "Page count of a PDF; null for an XML."
},
"valid": {
"type": [
"boolean",
"null"
],
"description": "`true`: the XML passed the KoSIT validator and, for a PDF, the PDF passed PDF/A-3b (warnings don't count). `false`: it failed (see `conformance`), or the file holds no e-invoice this check covers (see `reason`). `null` while the check is still running."
},
"reason": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"enum": [
"einvoice_not_found",
"einvoice_unsupported"
],
"type": "string"
},
"message": {
"type": "string",
"description": "What was found, e.g. the specification identifier that isn't supported."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Why there is no verdict: `einvoice_not_found`, the file is no e-invoice (neither a PDF nor an XML, a PDF without an embedded invoice XML, an XML that isn't an invoice); `einvoice_unsupported`, an e-invoice this check doesn't cover (e.g. ZUGFeRD 1.0, XRechnung before 3.0, Peppol BIS Billing 3.0). `null` with a verdict."
},
"status": {
"enum": [
"queued",
"processing",
"succeeded",
"failed",
"canceled",
"expired"
],
"type": "string",
"description": "`succeeded`: the validators gave a verdict, see `valid`. `queued` / `processing`: still running, collect it with `get_render`. `failed`: the file holds no e-invoice this check covers, see `reason`."
},
"totals": {
"anyOf": [
{
"type": "object",
"required": [
"line_total",
"allowance_total",
"charge_total",
"tax_basis_total",
"tax_total",
"grand_total",
"prepaid",
"rounding",
"due_payable"
],
"properties": {
"prepaid": {
"type": [
"string",
"null"
]
},
"rounding": {
"type": [
"string",
"null"
]
},
"tax_total": {
"type": [
"string",
"null"
]
},
"line_total": {
"type": [
"string",
"null"
]
},
"due_payable": {
"type": [
"string",
"null"
],
"description": "The amount due."
},
"grand_total": {
"type": [
"string",
"null"
]
},
"charge_total": {
"type": [
"string",
"null"
]
},
"allowance_total": {
"type": [
"string",
"null"
]
},
"tax_basis_total": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The document totals as stated (not recomputed), decimal strings; null with `invoice`."
},
"invoice": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
],
"description": "What the invoice states, with the field names of `create_einvoice`'s `invoice` (`number`, `issue_date`, `due_date`, `seller`, `buyer`, `payment.credit_transfers[].account_id` for the IBAN, `lines`, …): only what the document holds, values as written. Also for invalid invoices. Null without a verdict, when the XML can't be read, and in a zero-retention workspace when `get_render` collects the check (only the answer of the call that ran it carries the data)."
},
"document": {
"anyOf": [
{
"type": "object",
"required": [
"container",
"attachment",
"syntax",
"profile",
"specification_id"
],
"properties": {
"syntax": {
"type": "string",
"description": "`cii` or `ubl`."
},
"profile": {
"type": "string",
"description": "The profile its specification identifier names: MINIMUM, BASIC_WL, BASIC, EN16931, EXTENDED or XRECHNUNG."
},
"container": {
"enum": [
"pdf",
"xml"
],
"type": "string",
"description": "`pdf`: a hybrid PDF with the XML embedded; `xml`: a standalone XML."
},
"attachment": {
"type": [
"string",
"null"
],
"description": "The embedded file's name, e.g. `factur-x.xml`; null for an XML."
},
"specification_id": {
"type": "string",
"description": "The specification identifier (BT-24) as written in the XML."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "What the check found in the file; null without a verdict."
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "Non-fatal problems of the check itself; the validators' warnings are in `conformance`."
},
"reference": {
"type": [
"string",
"null"
],
"description": "The `reference` the call passed."
},
"render_id": {
"type": [
"string",
"null"
],
"description": "Id of the check (`rnd_…`), for `get_render`."
},
"created_at": {
"type": "string"
},
"conformance": {
"anyOf": [
{
"type": "object",
"properties": {
"pdfa": {
"type": "object",
"required": [
"level",
"status",
"errors",
"warnings"
],
"properties": {
"level": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"status": {
"enum": [
"passed",
"failed",
"unavailable"
],
"type": "string"
},
"profile": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"validator": {
"type": "string"
}
},
"additionalProperties": false
},
"einvoice": {
"type": "object",
"required": [
"profile",
"syntax",
"status",
"errors",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"status": {
"enum": [
"passed",
"failed",
"unavailable"
],
"type": "string"
},
"syntax": {
"type": "string"
},
"profile": {
"type": "string"
},
"scenario": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"validator": {
"type": "string"
}
},
"additionalProperties": false
}
},
"description": "Validation report: veraPDF for PDF/A, the KoSIT validator for the e-invoice XML. `unavailable` means the validator could not be reached and the file was delivered unvalidated.",
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The reports, `status` `passed` or `failed`: the KoSIT validator's on the XML (`einvoice`) and, for a PDF, veraPDF's PDF/A-3b report on the file as received (`pdfa`). Every rule the file breaks is in `errors`."
},
"completed_at": {
"type": [
"string",
"null"
]
},
"vat_breakdown": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"category",
"rate",
"basis",
"tax",
"exemption_reason",
"exemption_reason_code"
],
"properties": {
"tax": {
"type": [
"string",
"null"
]
},
"rate": {
"type": [
"string",
"null"
]
},
"basis": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"exemption_reason": {
"type": [
"string",
"null"
]
},
"exemption_reason_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
],
"description": "The VAT breakdown as the document states it (not recomputed); null with `invoice`."
},
"billed_renders": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Renders billed for the check: 1 for a verdict, valid or invalid; 0 for test checks and failed ones."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Validate an e-invoice (XRechnung, ZUGFeRD / Factur-X, EN 16931)",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}
The title clearly communicates the tool’s action and subject. Keep it concise.
Description98/100
Fetch one render of the connected workspace by id: its status, files with freshly signed download URLs, `billed_renders` and the conformance report. Use it when a render tool returned `queued` or `processing` (most renders reach `succeeded` or `failed` within seconds), or when a download link has expired. Not needed after a render tool already returned `succeeded` with its files. New URLs last the render's `expires_in` again, until the plan's file retention ends; after that the render is `expired` and its files have no URL. Not billed. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs99/100
Input documentation gives an agent enough context to populate the arguments.
render_id
Render id from a render tool's result, e.g. `rnd_01J9ZM…`.
The title clearly communicates the tool’s action and subject. Keep it concise.
Description97/100
Merge 2-200 existing PDFs into one PDF, in the order given, with a bookmark per source unless `bookmarks` is `none`. Use it to combine documents (e.g. a cover letter and an invoice from earlier renders) or PDFs at public URLs. It renders nothing itself, and the sources stay unchanged. Waits up to 25 s, then returns the files with signed download URLs valid for `expires_in` (default 1 h). A slower render comes back `queued` or `processing`: `get_render` collects it, and re-signs expired links. Test mode unless you pass `test: false`: test renders are free, carry a TEST watermark and are limited per minute by plan; final ones are billed (1 render per merge, whatever the page count), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.
The description explains the capability, when to use it, and what to expect.
Inputs88/100
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
sources › items › url
Public https URL of a PDF.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
sources › items › upload_id
A PDF uploaded through the API, e.g. `upl_…`.
Clear enough to supply this argument.
sources › items › render_id
An earlier render of this workspace whose files are still stored, e.g. `rnd_…`.
Clear enough to supply this argument.
sources › items › file_id
Which PDF of `render_id` to take (default: its first PDF).
Clear enough to supply this argument.
bookmarks
`filenames` (default): a top-level bookmark per source, named after its file; `none`: no bookmarks.
Clear enough to supply this argument.
filename
Output filename. Jinja is allowed, e.g. `invoice-{{ data.number }}.pdf`.
Clear enough to supply this argument.
reference
Your own identifier for this render; filterable later via the renders list.
Clear enough to supply this argument.
metadata
Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).
Clear enough to supply this argument.
test
Test mode. Test renders are free and carry a TEST watermark. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for the final document, which is billed. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test renders, a live key always final ones (`true` is refused).
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
expires_in
Lifetime of the signed download URLs, in seconds (default 3600, one hour). `get_render` signs fresh ones for the same lifetime.
{
"name": "merge_pdfs",
"title": "Merge PDFs",
"description": "Merge 2-200 existing PDFs into one PDF, in the order given, with a bookmark per source unless `bookmarks` is `none`. Use it to combine documents (e.g. a cover letter and an invoice from earlier renders) or PDFs at public URLs. It renders nothing itself, and the sources stay unchanged. Waits up to 25 s, then returns the files with signed download URLs valid for `expires_in` (default 1 h). A slower render comes back `queued` or `processing`: `get_render` collects it, and re-signs expired links. Test mode unless you pass `test: false`: test renders are free, carry a TEST watermark and are limited per minute by plan; final ones are billed (1 render per merge, whatever the page count), failed ones are free. Limited to 60 tool calls a minute per connection, shared by all tools.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sources"
],
"properties": {
"test": {
"type": "boolean",
"description": "Test mode. Test renders are free and carry a TEST watermark. Omitted, the server's default applies (test mode, unless it was configured otherwise). Pass `false` for the final document, which is billed. With an API key instead of a sign-in the key decides, whatever is passed: a test key always makes test renders, a live key always final ones (`true` is refused)."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Public https URL of a PDF."
},
"file_id": {
"type": "string",
"description": "Which PDF of `render_id` to take (default: its first PDF)."
},
"render_id": {
"type": "string",
"description": "An earlier render of this workspace whose files are still stored, e.g. `rnd_…`."
},
"upload_id": {
"type": "string",
"description": "A PDF uploaded through the API, e.g. `upl_…`."
}
},
"description": "Exactly one of `url`, `upload_id` or `render_id` (+ `file_id`)."
},
"maxItems": 200,
"minItems": 2,
"description": "The PDFs to merge, in order."
},
"filename": {
"type": "string",
"description": "Output filename. Jinja is allowed, e.g. `invoice-{{ data.number }}.pdf`."
},
"metadata": {
"type": "object",
"description": "Your own key/value pairs stored on the render (max 50 keys, values <= 500 chars).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"bookmarks": {
"enum": [
"filenames",
"none"
],
"type": "string",
"description": "`filenames` (default): a top-level bookmark per source, named after its file; `none`: no bookmarks."
},
"reference": {
"type": "string",
"maxLength": 255,
"description": "Your own identifier for this render; filterable later via the renders list."
},
"expires_in": {
"type": "integer",
"maximum": 604800,
"minimum": 60,
"description": "Lifetime of the signed download URLs, in seconds (default 3600, one hour). `get_render` signs fresh ones for the same lifetime."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"render_id",
"status",
"test",
"files"
],
"properties": {
"test": {
"type": "boolean",
"description": "A free test render, marked TEST; false for a final, billed one."
},
"error": {
"anyOf": [
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Why the render failed (`status: failed`)."
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"format",
"filename",
"bytes"
],
"properties": {
"id": {
"type": "string",
"description": "File id (`file_…`); `merge_pdfs` takes it as `file_id` with the `render_id`."
},
"url": {
"type": "string",
"description": "Download link; expires at `url_expires_at`, and an altered link doesn't open. Absent once the files are gone (`status: expired`)."
},
"bytes": {
"type": "number",
"description": "File size in bytes."
},
"pages": {
"type": [
"number",
"null"
],
"description": "Page count of a PDF."
},
"width": {
"type": [
"number",
"null"
],
"description": "Image width in pixels."
},
"format": {
"type": "string",
"description": "`pdf`, `png`, `jpeg`, `webp` or `xml`."
},
"height": {
"type": [
"number",
"null"
],
"description": "Image height in pixels."
},
"filename": {
"type": "string"
},
"url_expires_at": {
"type": "string",
"description": "When `url` stops working (ISO 8601); `get_render` signs a new one."
}
},
"additionalProperties": false
},
"description": "The output files, usually one."
},
"pages": {
"type": [
"number",
"null"
],
"description": "Page count of the PDF."
},
"status": {
"enum": [
"queued",
"processing",
"succeeded",
"failed",
"canceled",
"expired"
],
"type": "string",
"description": "`succeeded`: `files` are ready. `queued` / `processing`: still running, collect it with `get_render`. `failed`: see `error`. `expired`: the stored files are gone."
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "Non-fatal problems, e.g. `einvoice_skipped_plan` (the e-invoice was left out); tell the user."
},
"reference": {
"type": [
"string",
"null"
],
"description": "The `reference` the call passed."
},
"render_id": {
"type": "string",
"description": "Render id (`rnd_…`), for `get_render` and as a `merge_pdfs` source."
},
"created_at": {
"type": "string"
},
"conformance": {
"anyOf": [
{
"type": "object",
"properties": {
"pdfa": {
"type": "object",
"required": [
"level",
"status",
"errors",
"warnings"
],
"properties": {
"level": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"status": {
"enum": [
"passed",
"failed",
"unavailable"
],
"type": "string"
},
"profile": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"validator": {
"type": "string"
}
},
"additionalProperties": false
},
"einvoice": {
"type": "object",
"required": [
"profile",
"syntax",
"status",
"errors",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"status": {
"enum": [
"passed",
"failed",
"unavailable"
],
"type": "string"
},
"syntax": {
"type": "string"
},
"profile": {
"type": "string"
},
"scenario": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"rule",
"message"
],
"properties": {
"rule": {
"type": "string"
},
"count": {
"type": "number"
},
"message": {
"type": "string"
},
"location": {
"type": "string"
}
},
"additionalProperties": false
}
},
"validator": {
"type": "string"
}
},
"additionalProperties": false
}
},
"description": "Validation report: veraPDF for PDF/A, the KoSIT validator for the e-invoice XML. `unavailable` means the validator could not be reached and the file was delivered unvalidated.",
"additionalProperties": false
},
{
"type": "null"
}
]
},
"completed_at": {
"type": [
"string",
"null"
]
},
"output_format": {
"type": "string"
},
"billed_renders": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Renders billed for this render: 0 for test and failed ones."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Merge PDFs",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}
Loading score analytics…
Put your MCP to the test
A few tasks worth trying with this server, chosen from its reviewed tools. These have not been run.
01List Dynamic Document API templatesList the published templates of the connected workspace: id, name, type and live version.
02Get a template's data schemaGet the `data` a template expects before rendering it: its JSON Schema, every field as a dotted path with type and required flag, an image template's dynamic…
03Get a renderFetch one render of the connected workspace by id: its status, files with freshly signed download URLs, `billed_renders` and the conformance report.
04Validate an e-invoice (XRechnung, ZUGFeRD / Factur-X, EN 16931)Check an e-invoice someone sent: a Factur-X / ZUGFeRD PDF (or a PDF carrying `xrechnung.xml`), or an XRechnung or EN 16931 XML in CII or UBL.
Want to run these tasks against your MCP server with us?
Dynamic Document API setup, tools, quality score, publishing readiness, and alternatives.
How do I add Dynamic Document API to Claude, ChatGPT, or Cursor?
Add Dynamic Document API to Claude, ChatGPT, or Cursor by connecting its remote MCP URL in each client's MCP settings. In Claude, add a custom connector. In ChatGPT, add an MCP app. In Cursor, add an MCP server under Settings. The MCP URL is https://mcp.dynamicdocumentapi.com/mcp.
Is Dynamic Document API MCP ready for ChatGPT and Claude?
As of November 17, 2026, Dynamic Document API scores 100/100 on Manufact's MCP publishing checklist. The scan meets ChatGPT publishing checks and meets Claude publishing checks. Passing these checks does not guarantee marketplace approval.
How clear is Dynamic Document API's MCP tool documentation?
As of November 17, 2026, Dynamic Document API scores 91/100 in Manufact's review of tool titles, descriptions, input and output schemas, and behavior annotations. The review covers 10 of 10 discovered tools. The quality score measures documentation clarity; runtime behavior and marketplace readiness require separate checks.
What are the best alternatives to Dynamic Document API?
As of November 17, 2026, alternatives to Dynamic Document API in financial-services on the Manufact MCP leaderboard include Blockworks, SHVL credit control, BankConv, Economico, and DefiLlama.
Not your MCP?
Review any public or OAuth MCP server for protocol compatibility, tool documentation, and ChatGPT and Claude publishing readiness. No account required.