Brief und Vorlage prüfen
letter_previewRendert einen Brief, Entwurf oder ein Formular als Bild, so wie ein echter Versand ihn komponiert, und liefert Inline-PNGs, PDF-Link, Seitenzahl, Preis und designRender mit dem tatsächlichen documentMode, den gezeichneten Brief-Elementen und bodyStartMm. Die Vorschau ist kostenfrei, und der Brief bleibt liegen. Der Brief kommt über letterId, über eine freigegebene Vorlage (templateId, templateVersionId, templateMergeValues) oder inline mit content ODER blocks; der Empfänger über recipientAddressId oder die recipient-Felder. Bei letterId ist die eingebettete Karte die Vorschau für den Menschen; PDF-Link und Brieftext stehen zusätzlich im Ergebnis, für reine Textansichten. Ein ungespeichertes design gilt nur für diese eine Vorschau. Eigenständige Formulare (Selbstauskunft, Fragebogen, Zertifikat) rendern mit design: { "schemaVersion": 1, "documentMode": "form" } als Formular: dann entfallen Empfängerblock, Datum und Betreff, und der Inhalt beginnt bei 27 mm. Kompaktes blocks-Beispiel: {"blocks":[{"type":"heading","text":"Rechnung"},{"type":"table","columns":[{"key":"text","label":"Artikel","width":"grow"},{"key":"sum","label":"Summe","align":"right","format":"eur"}],"rows":[{"text":"Beratung","sum":32000}]},{"type":"totals","lines":[{"label":"Gesamt","amountCents":32000,"emphasis":true}]}]} Schema-Referenz: frankki://blocks-guide. Beim Nachbau eines Originals zeigen die PNGs Seite für Seite, ob Seitenzahl und wesentliche Geometrie passen; geänderte blocks oder ein geändertes design rendern im nächsten letter_preview-Aufruf neu. Das passende Layout speichert template_save als Entwurf, template_release gibt es frei. EN: Renders a letter, draft or form as images, composed like a real send, and returns inline PNGs, PDF link, page count, cost and designRender with the actual documentMode, rendered letter chrome and bodyStartMm. The preview is free and the letter stays put. The letter comes via letterId, a released template (templateId, templateVersionId, templateMergeValues) or inline content OR blocks; the recipient via recipientAddressId or the recipient fields. With letterId, the embedded card is the human preview; the PDF link and letter text are also in the result, for text-only views. An unsaved design applies to this one preview only. Standalone forms (self-declaration, questionnaire, certificate) render as a form with design: { "schemaVersion": 1, "documentMode": "form" }: that drops recipient block, date and subject and starts content at 27 mm. Schema reference: frankki://blocks-guide. For a rebuild of an original, the PNGs show page by page whether page count and major geometry match; changed blocks or a changed design render again on the next letter_preview call. template_save stores the matching layout as a draft, template_release releases it.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "letter_preview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pages | No | Wie viele Seiten als Bild zurückkommen. Standard 3, Maximum 8. Der PDF-Link enthält alle Seiten. EN: How many pages come back as images. Default 3, maximum 8. The PDF link contains every page. | |
| blocks | No | Strukturierter Briefinhalt als typisierte Blöcke, an Stelle von content. Limits: 200 Blöcke, 100 Zeilen/Tabelle, 20 Spalten, 2000 Zeichen/Zelle, 10 Bilder, 262144 Bytes. Jeder Block braucht type; erlaubte Typen: paragraph, heading, keyValue, checkboxRow, fillLine, table, totals, columns, box, image, spacer, pageBreak. Feldreferenz: MCP-Ressource frankki://blocks-guide. EN: Structured letter content as typed blocks, in place of content. Limits: 200 blocks, 100 rows per table, 20 columns, 2000 characters per cell, 10 images, 262144 bytes. Every block needs type; allowed types: paragraph, heading, keyValue, checkboxRow, fillLine, table, totals, columns, box, image, spacer, pageBreak. Field reference: MCP resource frankki://blocks-guide. | |
| design | No | Ungespeichertes Briefdesign nur für diese Vorschau. Hat Vorrang vor designId und erzeugt keinen Eintrag im Konto. Eigenständige Formulare rendern mit documentMode: "form". EN: Unsaved letter design for this preview only. Takes precedence over designId and creates no account entry. Standalone forms render with documentMode: "form". | |
| content | No | Brieftext als Fließtext. Genau eines von content und blocks. EN: Letter body as plain text. Exactly one of content and blocks. | |
| subject | No | Betreff. Ohne letterId erforderlich. EN: Subject. Required without a letterId. | |
| designId | No | Gespeichertes Briefdesign für diese Vorschau. EN: Saved letter design for this preview. | |
| language | No | ||
| letterId | No | Gespeicherter Entwurf für die Vorschau. Alternativ kommt der Brief inline. EN: Stored draft to preview. The letter can come inline instead. | |
| reasoning | No | ||
| reference | No | Werte für diesen Brief (Vorgangsnummer, Ihr Zeichen, Kundennummer, QR-Parameter ...). Sie füllen Infoblock und Barcode in der Vorschau. EN: Per-letter values (Vorgangsnummer, Ihr Zeichen, customer number, QR parameters ...). They fill the info block and barcode in the preview. | |
| styleDefs | No | Benannte Stile für das ganze Dokument (max. 24). Blöcke referenzieren sie über style. Stilfelder: frankki://blocks-guide. EN: Named document styles (max 24); blocks reference them via style. Style fields: frankki://blocks-guide. | |
| resolution | No | thumb (96 dpi, Standard, schnell und klein) oder full (150 dpi, zum Prüfen von Details). EN: thumb (96 dpi, default, fast and small) or full (150 dpi, for checking details). | |
| templateId | No | ||
| recipientZip | No | ||
| recipientCity | No | ||
| recipientName | No | ||
| recipientStreet | No | ||
| senderProfileId | No | ||
| recipientCompany | No | ||
| recipientCountry | No | ISO-3166-alpha-2, Standard DE. EN: ISO 3166-1 alpha-2, defaults to DE. | |
| templateVersionId | No | Freigegebene Vorlagenversion, zusammen mit templateId und templateMergeValues: zeigt genau den Brief, den order_send damit verschickt. EN: Released template version, with templateId and templateMergeValues: shows exactly the letter order_send would send with them. | |
| recipientAddressId | No | Empfänger aus dem Adressbuch. Alternativ die recipient-Felder; fehlt beides, steht ein Musterempfänger im Fenster. EN: Recipient from the address book. Alternatively the recipient fields; if both are missing, a sample recipient fills the window. | |
| templateMergeValues | No | ||
| recipientHouseNumber | No |