Zum Inhalt springen

Connect-Cookbook

NextPDF Connect öffnet die NextPDF-Engine für entfernte Aufrufer und KI-Systeme über das Model Context Protocol, eine REST-API und einen gRPC-Service. Das Connect-Cookbook sammelt die Task-Recipes für diese Oberfläche; diese Seite dient als Index. Sie hält den Slug fest, den jedes Recipe belegt, sowie die Stufe und die Transportgrenze, in deren Kontext jedes Recipe gelesen wird. Da es sich um einen Index handelt, trifft er keine Verhaltensaussagen zu einzelnen Recipes. Jede Recipe-Seite wird im Repository nextpdf/server unter docs/public/ verfasst, enthält ihre eigenen Aussagen und wird vom Aggregator mit intakter Quellenherkunft in diese Site übernommen.

Den Vertrag, dem jedes Connect-Recipe folgt, finden Sie unter Recipe-Konventionen. Die ökosystemweite Integrationslandschaft beschreibt das Integrations-Cookbook.

Wie die Stufe beeinflusst, was Sie ausführen können

Abschnitt betitelt „Wie die Stufe beeinflusst, was Sie ausführen können“

Der Toolsatz eines Connect-Deployments wird beim Booten berechnet und nicht im Voraus festgelegt. Die Tool-Registry des Servers registriert die Core-Tools bedingungslos. Anschließend prüft sie mit class_exists() auf die Pro- und Enterprise-Provider und registriert deren Tools nur dann, wenn nextpdf/premium neben dem Server installiert ist. Ein Recipe, das von einem Pro- oder Enterprise-Tool abhängt, läuft also nur auf einem Deployment, auf dem dieses Tool aufgelöst wurde. Auf einer reinen Open-Source-Installation ist das Tool nicht vorhanden, und der Aufruf gibt einen Unknown-Tool-Fehler zurück, statt stillschweigend auf einen geringeren Funktionsumfang zurückzufallen. Jedes Recipe nennt seine Stufe; dieser Index gruppiert die Recipes nach Stufe, damit Sie auf einen Blick erkennen, was ein bestimmtes Deployment unterstützt.

Die Gesamtzahl der Tools ist eine Laufzeiteigenschaft des Deployments. Weder ein Recipe noch eine Zeile in diesem Index behauptet eine feste Zahl. Maßgeblich ist der eigene Tool-Katalog des Servers, auf den jedes Recipe verlinkt.

Sie rufen jedes Recipe über alle drei Transporte auf dieselbe Weise auf: über einen MCP-tools/call, den REST-Tool-Endpunkt oder den gRPC-Service. Der Grund ist, dass alle drei denselben Tool-Executor verwenden. Recipes, die einen entfernten Service über HTTP erreichen, behandeln einen Transportfehler und einen nicht erfolgreichen HTTP-Status als zwei getrennte Fälle. Ein PSR-18-Client wirft nur dann eine typisierte Client-Exception, wenn er die Anfrage überhaupt nicht senden kann, siehe PSR-18 §4. Eine 4xx- oder 5xx-Antwort ist dagegen ein normaler Rückgabewert, den der Aufrufer prüft, keine Exception; siehe PSR-18 §4.

Jedes Recipe liegt unter /cookbook/connect/<recipe>/. Die Tabelle dokumentiert den Slug, die Stufe, unter der das Recipe gelesen wird, und einen einzeiligen Geltungsbereich. Die Recipe-Seiten werden in nextpdf/serverdocs/public/ verfasst und hier aggregiert. Bis eine Seite erscheint, ist ihr Link eine Vorwärtsreferenz.

RecipeStufeGeltungsbereich
hello-world (Upstream geplant)CoreErster Connect-Aufruf: erstellen, Inhalt hinzufügen, ausgeben
multi-page (Upstream geplant)CoreMehrseitiges Dokument über Connect
image-embedding (Upstream geplant)CoreEin Bild über Connect einbetten
html-table (Upstream geplant)CoreEine HTML-Tabelle über Connect rendern
font-typography (Upstream geplant)CoreSchriften und Typografie über Connect
exception-aware (Upstream geplant)CoreException-bewusste Tool-Aufrufe
environment-diagnostics (Upstream geplant)CoreTools zur Umgebungsdiagnose
layout-inspection (Upstream geplant)CoreLayout ohne Rendering inspizieren
worker-safe (Upstream geplant)CoreWorker-sichere Batch-Nutzung
output-approval (Upstream geplant)CoreDas Output-Gate mit Mensch in der Schleife
event-hooks (Upstream geplant)CoreLifecycle-Event-Hooks
fill-pdf-form (Upstream geplant)ProEin PDF-Formular über Connect ausfüllen
extract-text-content (Upstream geplant)ProTextinhalt über Connect extrahieren
digital-signature (Upstream geplant)ProEin PDF über Connect signieren (PAdES B-B und B-T)
accessibility-check (Upstream geplant)ProPDF/UA-Barrierefreiheitsprüfung
pii-redaction (Upstream geplant)EnterpriseErkannte personenbezogene Daten aus der Textebene entfernen (destruktiv)
aria-tagged-pdf (Upstream geplant)ProARIA-Landmark-Rollen auf getaggte Struktur abbilden
figure-caption (Upstream geplant)ProBarrierefreie Figure mit verschachtelter Caption
aria-noteref-pattern (Upstream geplant)ProFußnotenreferenz- und Textkörper-Muster
compliance-check (Upstream geplant)EnterpriseEine Prüfung nach benanntem Standard ausführen
forensic-analysis (Upstream geplant)EnterpriseForensische Analyse eines signierten PDFs
ltv-health-check (Upstream geplant)EnterpriseLTV-Zustandsprüfung (B-LT/B-LTA, nur Enterprise)
batch-compliance (Upstream geplant)EnterpriseBatch-Standardprüfung
ai-ready-certification (Upstream geplant)EnterpriseKI-Bereitschaftsprüfung (keine Zertifizierung)
page-artifacts (Upstream geplant)EnterprisePaginierungs-Chrome als Artefakte markieren
conformance-mode (Upstream geplant)EnterpriseEinen Konformitätsmodus auswählen (soll konform sein; ein Validator entscheidet)
cjk-vertical-writing (Upstream geplant)EnterpriseMetriken für vertikale CJK-Schreibrichtung
opentelemetry (Upstream geplant)CoreConnect mit OpenTelemetry beobachten
tagged-pdf-tutorial (Upstream geplant)CoreTutorial für getaggtes PDF (soll konform sein; veraPDF entscheidet)

Der Slug bildet die Absicht des Recipes in Kebab-Case mit einem einzigen abschließenden Schrägstrich ab: kein numerisches Präfix, keine Versionsnummer, keine Dateiendung. Ein Recipe-Slug ändert sich nach der Veröffentlichung nicht, und ein verschobener Slug erhält einen Redirect.

Mehrere Recipes berühren Standards (PDF/UA-2, PDF/A-4, PAdES). Das Connect-Cookbook versteht die Unterstützung eines Standards als Unterstützung, niemals als Konformität oder Zertifizierung. Die Engine erzeugt Ausgaben, die konform sein sollen, und ein unabhängiger Validator (zum Beispiel veraPDF) bestimmt die Konformität. Das KI-Bereitschafts-Recipe ist eine Bereitschaftsprüfung, keine Zertifizierung. Das Long-Term-Validation-Material des LTV-Recipes ist eine reine Enterprise-Fähigkeit. Wenn es in einem Dokument vorhanden ist, trägt das Dokument diese Fähigkeit; es ist keine Garantie für unbegrenzte Signaturgültigkeit. Jedes betroffene Recipe wiederholt diese Grenzen vollständig. Dieser Index merkt nur an, dass sie existieren, und verweist darauf, woraus sie hergeleitet werden, statt sie hier erneut herzuleiten.