pdfnative-mcp

Embed image in PDF

embed_image

Idempotent

Create a single-page PDF from a JPEG or PNG base64 image, with optional caption, size, and margins. Configure PDF/A, encryption, and print options for compliant output.

Instructions

PDF with one embedded JPEG or PNG (base64; PNG without alpha channel) plus optional caption and render width/height. Inside a longer document use an 'image' block of generate_basic_pdf instead. PDF/A, print, metadata and creationDate options as on every document tool.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`alt`	No	Accessible description of the image (tagged /Figure /Alt). Provide it for non-decorative images under PDF/A or PDF/UA.
`pdfA`	No	PDF/A level: pdfa1b (simple text+images), pdfa2b/pdfa2u (richer; 2u = Unicode mapping), pdfa3b (attachments / Factur-X). Pair with embedFonts=true for a valid claim. Exclusive with encryption. See docs/guides/PDFA.md.
`align`	No	Horizontal placement of the image inside the content width.	left
`debug`	No	Draw margin / block / cell guide rectangles (unmarked content — not for PDF/UA output). Geometry unchanged. Default false.
`print`	No	Print production (ISO 32000-1 §14.11): page boxes, `bleed` shorthand (TrimBox = MediaBox inset), crop/registration marks outside the TrimBox, /UserUnit for large formats (PDF 1.7; not under pdfa1b). See docs/guides/PRINT.md.
`title`	Yes	Document title rendered at the top and used as PDF metadata title.
`width`	No	Render width in points. If omitted, the image is auto-sized to fit the page.
`height`	No	Render height in points. If omitted, aspect ratio is preserved.
`strict`	No	Fail with PDF_A_COMPLIANCE_VIOLATION instead of producing a non-conformant PDF/A file (e.g. PDFA_NO_FONT_ENTRIES without embedFonts). Pair with embedFonts=true.
`caption`	No	Optional caption rendered below the image.
`encrypt`	No	Encrypt at build time (AES-128 default / AES-256) and KEEP the AcroForm — unlike encrypt_pdf, which rebuilds the page tree. Exclusive with pdfA. Randomised output, never cached.
`margins`	No	Margins in points, all four required (0–200). Default 45 / 36 / 35 / 36.
`compress`	No	FlateDecode the streams (smaller file, different bytes; PDF/A unaffected, XMP stays plain). Default false.
`metadata`	No	/Info (+ XMP under PDF/A): author, subject, keywords, /Trapped.
`mimeType`	Yes	MIME type of the image. Must match the actual encoding of imageBase64 (magic bytes are checked).
`pageSize`	No	Portrait page preset (points): A4 595.28×841.89 (default), Letter 612×792, Legal 612×1008, A3 841.89×1190.55, Tabloid 792×1224. print.* boxes must fit it.
`embedFonts`	No	Embed Noto Sans Latin instead of the viewer base-14 Helvetica. REQUIRED for a valid PDF/A claim (ISO 19005 §6.2.11.4.1) and for strict=true; adds ~0.3 MiB.
`outputMode`	No	Either 'base64' (returns the PDF inline) or 'file' (writes to a sandboxed path inside PDFNATIVE_MCP_OUTPUT_DIR).	base64
`outputPath`	No	Required when outputMode='file'. Relative path inside the sandbox; must end with .pdf.
`imageBase64`	Yes	Base64 image bytes. JPEG (baseline; 1, 3 or 4 components — CMYK raises PDFA_DEVICE_CMYK_IMAGE under PDF/A) or PNG (8-bit greyscale/RGB, non-interlaced; alpha-channel and palette PNGs are rejected with a remedy). No data: URI.
`creationDate`	No	ISO-8601 instant for /CreationDate (+ XMP). Pin it for byte-identical output across calls (same host TZ); omitted = wall clock, so every call differs.
`outputIntent`	No	Custom PDF/A OutputIntent: an RGB ICC profile + condition strings replacing the built-in sRGB intent (CMYK rejected).
`footerTemplate`	No	Running footer on every page. Replaces the default footer: footerText is then ignored and page numbers appear only via {page}/{pages}.
`headerTemplate`	No	Running header on every page (left / center / right zones); reserves 15 pt.
`includeDiagnostics`	No	Return the PDF/A diagnostics raised while building as `diagnostics[]` (possibly empty).

Output Schema

TableJSON Schema

Name	Required	Description
`mode`	Yes
`summary`	No	Tool-specific summary, when produced.
`filePath`	No	Sandboxed absolute path (file mode).
`sizeBytes`	Yes
`diagnostics`	No	PDF/A diagnostics (when includeDiagnostics=true).

Schema Changelog

Changes observed during successful MCP inspections.

Changed23 schema fields changedAug 24, 2026

addedInput schema / properties / align

Added value: +{
+  "default": "left",
+  "description": "Horizontal placement of the image inside the content width.",
+  "enum": [
+    "left",
+    "center",
+    "right"
+  ],
+  "type": "string"
+}

addedInput schema / properties / alt

Added value: +{
+  "description": "Accessible description of the image (tagged /Figure /Alt). Provide it for non-decorative images under PDF/A or PDF/UA.",
+  "maxLength": 500,
+  "type": "string"
+}

addedInput schema / properties / compress

Added value: +{
+  "description": "FlateDecode the streams (smaller file, different bytes; PDF/A unaffected, XMP stays plain). Default false.",
+  "type": "boolean"
+}

addedInput schema / properties / creationDate

Added value: +{
+  "description": "ISO-8601 instant for /CreationDate (+ XMP). Pin it for byte-identical output across calls (same host TZ); omitted = wall clock, so every call differs.",
+  "format": "date-time",
+  "type": "string"
+}

addedInput schema / properties / debug

Added value: +{
+  "description": "Draw margin / block / cell guide rectangles (unmarked content — not for PDF/UA output). Geometry unchanged. Default false.",
+  "type": "boolean"
+}

addedInput schema / properties / embedFonts

Added value: +{
+  "default": false,
+  "description": "Embed Noto Sans Latin instead of the viewer base-14 Helvetica. REQUIRED for a valid PDF/A claim (ISO 19005 §6.2.11.4.1) and for strict=true; adds ~0.3 MiB.",
+  "type": "boolean"
+}

addedInput schema / properties / encrypt

Added value: +{
+  "additionalProperties": false,
+  "description": "Encrypt at build time (AES-128 default / AES-256) and KEEP the AcroForm — unlike encrypt_pdf, which rebuilds the page tree. Exclusive with pdfA. Randomised output, never cached.",
+  "properties": {
+    "algorithm": {
+      "default": "aes128",
+      "description": "aes128 (V4/R4, widest compatibility) or aes256 (V5/R6).",
+      "enum": [
+        "aes128",
+        "aes256"
+      ],
+      "type": "string"
+    },
+    "ownerPassword": {
+      "description": "Owner password (full access).",
+      "maxLength": 4096,
+      "minLength": 1,
+      "type": "string"
+    },
+    "permissions": {
+      "additionalProperties": false,
+      "description": "Permission flags; each defaults to allowed.",
+      "properties": {
+        "copy": {
+          "type": "boolean"
+        },
+        "extractText": {
+          "type": "boolean"
+        },
+        "modify": {
+          "type": "boolean"
+        },
+        "print": {
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "userPassword": {
+      "description": "Open password; omitted/empty = opens without a prompt.",
+      "maxLength": 4096,
+      "type": "string"
+    }
+  },
+  "required": [
+    "ownerPassword"
+  ],
+  "type": "object"
+}

addedInput schema / properties / footerTemplate

Added value: +{
+  "additionalProperties": false,
+  "description": "Running footer on every page. Replaces the default footer: footerText is then ignored and page numbers appear only via {page}/{pages}.",
+  "properties": {
+    "center": {
+      "description": "Placeholders: {page} {pages} {title} {date} (build-day wall clock, not creationDate).",
+      "maxLength": 200,
+      "type": "string"
+    },
+    "color": {
+      "description": "Hex colour.",
+      "pattern": "^#[0-9a-fA-F]{6}$",
+      "type": "string"
+    },
+    "fontSize": {
+      "description": "Default 7.",
+      "maximum": 14,
+      "minimum": 6,
+      "type": "number"
+    },
+    "left": {
+      "description": "Placeholders: {page} {pages} {title} {date} (build-day wall clock, not creationDate).",
+      "maxLength": 200,
+      "type": "string"
+    },
+    "right": {
+      "description": "Placeholders: {page} {pages} {title} {date} (build-day wall clock, not creationDate).",
+      "maxLength": 200,
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

addedInput schema / properties / headerTemplate

Added value: +{
+  "additionalProperties": false,
+  "description": "Running header on every page (left / center / right zones); reserves 15 pt.",
+  "properties": {
+    "center": {
+      "description": "Placeholders: {page} {pages} {title} {date} (build-day wall clock, not creationDate).",
+      "maxLength": 200,
+      "type": "string"
+    },
+    "color": {
+      "description": "Hex colour.",
+      "pattern": "^#[0-9a-fA-F]{6}$",
+      "type": "string"
+    },
+    "fontSize": {
+      "description": "Default 7.",
+      "maximum": 14,
+      "minimum": 6,
+      "type": "number"
+    },
+    "left": {
+      "description": "Placeholders: {page} {pages} {title} {date} (build-day wall clock, not creationDate).",
+      "maxLength": 200,
+      "type": "string"
+    },
+    "right": {
+      "description": "Placeholders: {page} {pages} {title} {date} (build-day wall clock, not creationDate).",
+      "maxLength": 200,
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

changedInput schema / properties / imageBase64 / description

Previous value: -"Base64-encoded image bytes. Supports JPEG and PNG formats."New value: +"Base64 image bytes. JPEG (baseline; 1, 3 or 4 components — CMYK raises PDFA_DEVICE_CMYK_IMAGE under PDF/A) or PNG (8-bit greyscale/RGB, non-interlaced; alpha-channel and palette PNGs are rejected with a remedy). No data: URI."

addedInput schema / properties / includeDiagnostics

Added value: +{
+  "default": false,
+  "description": "Return the PDF/A diagnostics raised while building as `diagnostics[]` (possibly empty).",
+  "type": "boolean"
+}

addedInput schema / properties / margins

Added value: +{
+  "additionalProperties": false,
+  "description": "Margins in points, all four required (0–200). Default 45 / 36 / 35 / 36.",
+  "properties": {
+    "bottom": {
+      "maximum": 200,
+      "minimum": 0,
+      "type": "number"
+    },
+    "left": {
+      "maximum": 200,
+      "minimum": 0,
+      "type": "number"
+    },
+    "right": {
+      "maximum": 200,
+      "minimum": 0,
+      "type": "number"
+    },
+    "top": {
+      "maximum": 200,
+      "minimum": 0,
+      "type": "number"
+    }
+  },
+  "required": [
+    "top",
+    "right",
+    "bottom",
+    "left"
+  ],
+  "type": "object"
+}

addedInput schema / properties / metadata

Added value: +{
+  "additionalProperties": false,
+  "description": "/Info (+ XMP under PDF/A): author, subject, keywords, /Trapped.",
+  "properties": {
+    "author": {
+      "maxLength": 500,
+      "type": "string"
+    },
+    "keywords": {
+      "maxLength": 1000,
+      "type": "string"
+    },
+    "subject": {
+      "maxLength": 1000,
+      "type": "string"
+    },
+    "trapped": {
+      "description": "/Trapped print flag.",
+      "enum": [
+        "True",
+        "False",
+        "Unknown"
+      ],
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

changedInput schema / properties / mimeType / description

Previous value: -"MIME type of the image. Must match the actual encoding of imageBase64."New value: +"MIME type of the image. Must match the actual encoding of imageBase64 (magic bytes are checked)."

addedInput schema / properties / outputIntent

Added value: +{
+  "additionalProperties": false,
+  "description": "Custom PDF/A OutputIntent: an RGB ICC profile + condition strings replacing the built-in sRGB intent (CMYK rejected).",
+  "properties": {
+    "iccProfileBase64": {
+      "description": "ICC profile bytes, base64 (RGB, ≤ 8 MiB).",
+      "maxLength": 11000000,
+      "minLength": 1,
+      "type": "string"
+    },
+    "info": {
+      "maxLength": 500,
+      "type": "string"
+    },
+    "outputCondition": {
+      "maxLength": 200,
+      "type": "string"
+    },
+    "outputConditionIdentifier": {
+      "description": "e.g. \"sRGB IEC61966-2.1\".",
+      "maxLength": 200,
+      "minLength": 1,
+      "type": "string"
+    },
+    "registryName": {
+      "description": "Default \"http://www.color.org\".",
+      "maxLength": 200,
+      "type": "string"
+    }
+  },
+  "required": [
+    "iccProfileBase64",
+    "outputConditionIdentifier"
+  ],
+  "type": "object"
+}

addedInput schema / properties / pageSize

Added value: +{
+  "description": "Portrait page preset (points): A4 595.28×841.89 (default), Letter 612×792, Legal 612×1008, A3 841.89×1190.55, Tabloid 792×1224. print.* boxes must fit it.",
+  "enum": [
+    "A4",
+    "Letter",
+    "Legal",
+    "A3",
+    "Tabloid"
+  ],
+  "type": "string"
+}

changedInput schema / properties / pdfA / description

Previous value: -"Optional PDF/A conformance level (powered by pdfnative v1.2). Use 'pdfa1b' for archival of simple text+images, 'pdfa2b'/'pdfa2u' for richer content (2u guarantees Unicode mapping), 'pdfa3b' when embedding source attachments (Factur-X / ZUGFeRD). Mutually exclusive with PDF encryption. See docs/guides/PDFA.md."New value: +"PDF/A level: pdfa1b (simple text+images), pdfa2b/pdfa2u (richer; 2u = Unicode mapping), pdfa3b (attachments / Factur-X). Pair with embedFonts=true for a valid claim. Exclusive with encryption. See docs/guides/PDFA.md."

addedInput schema / properties / print

Added value: +{
+  "additionalProperties": false,
+  "description": "Print production (ISO 32000-1 §14.11): page boxes, `bleed` shorthand (TrimBox = MediaBox inset), crop/registration marks outside the TrimBox, /UserUnit for large formats (PDF 1.7; not under pdfa1b). See docs/guides/PRINT.md.",
+  "properties": {
+    "artBox": {
+      "description": "[x0, y0, x1, y1] in points, origin bottom-left, inside the MediaBox.",
+      "items": {
+        "type": "number"
+      },
+      "maxItems": 4,
+      "minItems": 4,
+      "type": "array"
+    },
+    "bleed": {
+      "description": "Bleed in points (8.5 = 3 mm); sets TrimBox = MediaBox inset. Exclusive with trimBox.",
+      "exclusiveMinimum": 0,
+      "maximum": 200,
+      "type": "number"
+    },
+    "bleedBox": {
+      "description": "[x0, y0, x1, y1] in points, origin bottom-left, inside the MediaBox.",
+      "items": {
+        "type": "number"
+      },
+      "maxItems": 4,
+      "minItems": 4,
+      "type": "array"
+    },
+    "cropBox": {
+      "description": "[x0, y0, x1, y1] in points, origin bottom-left, inside the MediaBox.",
+      "items": {
+        "type": "number"
+      },
+      "maxItems": 4,
+      "minItems": 4,
+      "type": "array"
+    },
+    "marks": {
+      "description": "Printer's marks (needs bleed or trimBox): true for defaults, or an object.",
+      "oneOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "crop": {
+              "description": "Corner crop (trim) marks. Default true.",
+              "type": "boolean"
+            },
+            "length": {
+              "description": "Mark length in points. Default 14.",
+              "maximum": 100,
+              "minimum": 1,
+              "type": "number"
+            },
+            "offset": {
+              "description": "Gap between TrimBox and marks in points. Default 5.",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "registration": {
+              "description": "Edge-midpoint registration targets. Default true.",
+              "type": "boolean"
+            },
+            "weight": {
+              "description": "Stroke width in points. Default 0.25.",
+              "maximum": 5,
+              "minimum": 0.05,
+              "type": "number"
+            }
+          },
+          "type": "object"
+        }
+      ]
+    },
+    "trimBox": {
+      "description": "[x0, y0, x1, y1] in points, origin bottom-left, inside the MediaBox.",
+      "items": {
+        "type": "number"
+      },
+      "maxItems": 4,
+      "minItems": 4,
+      "type": "array"
+    },
+    "userUnit": {
+      "description": "/UserUnit (multiples of 1/72 in) for pages over 14400 pt. Rejected under pdfa1b.",
+      "maximum": 75000,
+      "minimum": 1,
+      "type": "number"
+    }
+  },
+  "type": "object"
+}

addedInput schema / properties / strict

Added value: +{
+  "default": false,
+  "description": "Fail with PDF_A_COMPLIANCE_VIOLATION instead of producing a non-conformant PDF/A file (e.g. PDFA_NO_FONT_ENTRIES without embedFonts). Pair with embedFonts=true.",
+  "type": "boolean"
+}

changedOutput schema / description

Previous value: -"Structured result of a PDF-producing tool. In base64 mode the PDF bytes are delivered out-of-band as an embedded `resource` content block (data: URI), NOT duplicated here, to keep responses token-frugal. In file mode `filePath` is the sandboxed absolute path."New value: +"Result of a PDF-producing tool. base64 mode: the PDF arrives as an embedded `resource` content block (not duplicated here); file mode: `filePath`."

addedOutput schema / properties / diagnostics

Added value: +{
+  "description": "PDF/A diagnostics (when includeDiagnostics=true).",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "code": {
+        "type": "string"
+      },
+      "message": {
+        "type": "string"
+      },
+      "severity": {
+        "enum": [
+          "warning"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "code",
+      "message",
+      "severity"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

changedOutput schema / properties / filePath / description

Previous value: -"Absolute sandboxed file path (when mode='file')."New value: +"Sandboxed absolute path (file mode)."

addedOutput schema / properties / summary

Added value: +{
+  "additionalProperties": true,
+  "description": "Tool-specific summary, when produced.",
+  "type": "object"
+}

Changed2 schema fields changedv1.2.0Jun 24, 2026

addedOutput schema / description

Added value: +"Structured result of a PDF-producing tool. In base64 mode the PDF bytes are delivered out-of-band as an embedded `resource` content block (data: URI), NOT duplicated here, to keep responses token-frugal. In file mode `filePath` is the sandboxed absolute path."

removedOutput schema / properties / base64

Removed value: -{
-  "description": "Base64-encoded PDF bytes (when mode='base64').",
-  "type": "string"
-}

First observedv1.1.0Jun 20, 2026

TDQS

A4.1/5.0

Behavior3/5

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

Annotations already provide readOnlyHint=false, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds the 'PNG without alpha channel' input constraint (already present in the schemas) and the cross-tool option pattern, but reveals no new behavioral traits beyond what annotations and schema already state. No contradiction exists.

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?

Three sentences with each carrying a distinct role: scope definition, sibling alternative, and cross-tool option pattern. The final sentence is slightly abstract but avoids redundancy, and the description is front-loaded with the clarifying scope before routing guidance.

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?

For a 25-parameter tool with an output schema and rich parameter descriptions, the description covers the essential invocation decision and defers the rest to the schema. The main omission is any high-level note about output behavior, but the output schema and idempotency annotation fill that gap adequately.

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 100%, so the schema already documents all 25 parameters. The description briefly names caption, render width/height, and the doc-wide options group, but provides no new semantic detail beyond what the parameter schemas already give.

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 the scope precisely: one PDF with a single embedded base64 JPEG/PNG, optional caption, and render width/height. It explicitly names generate_basic_pdf's 'image' block for longer documents, which differentiates it from the most similar sibling tool without opening any schemas.

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?

Gives an explicit when-not-to-use rule with the alternative tool: 'Inside a longer document use an image block of generate_basic_pdf instead.' This directly routes the agent to the correct sibling, with the positive use case for this tool implied by contrast.

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