Connect cookbook
Connect cookbook
Section titled “Connect cookbook”NextPDF Connect opens the NextPDF engine to remote callers and artificial
intelligence (AI) systems over the Model Context Protocol (MCP), a
Representational State Transfer (REST) API, and a gRPC service. The Connect
cookbook gathers the task recipes for that surface, and this page is its
index. It records each recipe slug, the tier it belongs to, and the
transport boundary that applies. Because this page is an index, it makes no
behavioral claim about any recipe. Each recipe page is authored in the
nextpdf/server repository under docs/public/, owns its own claims, and
is pulled into this site by the aggregator with its source provenance
intact.
To see the contract every Connect recipe follows, read Recipe conventions. For the full ecosystem integration landscape, read the Integration cookbook.
How tier affects what you can run
Section titled “How tier affects what you can run”A Connect deployment computes its tool set at boot; it is not fixed in
advance. The server’s tool registry always registers the core tools. It
then probes for the Pro and Enterprise providers with class_exists(), and
registers their tools only when nextpdf/premium is installed alongside
the server. A recipe that depends on a Pro or Enterprise tool runs only on a
deployment where that tool resolved. On an open-source-only install, the
tool is absent, and the call returns an unknown-tool error instead of
degrading silently. Each recipe states its tier, and this index groups
recipes by tier so you can see what a deployment supports at a glance.
The total tool count is a runtime property of the deployment. No recipe and no row in this index asserts a fixed number. The catalog of record is the server’s own tool catalog, which each recipe links.
Transport and error model
Section titled “Transport and error model”You invoke every recipe the same way over all three transports: an MCP
tools/call, the REST tool endpoint, or the gRPC service. They share one
tool executor. Recipes that reach a remote service over Hypertext Transfer
Protocol (HTTP) treat a transport failure and a non-success HTTP status as
separate cases. A PSR-18 client raises a typed client exception only when
it cannot send the request at all, as described in PSR-18 §4. A 4xx or
5xx response is different. It is a normal return value that the caller
inspects, not an exception, as described in PSR-18 §4.
The recipe slug map
Section titled “The recipe slug map”Each recipe lives at /cookbook/connect/<recipe>/. The table records the
slug, the tier the recipe is read under, and a one-line scope. The recipe
pages are authored in nextpdf/serverdocs/public/ and aggregate here.
Until a page lands, its link is a forward reference.
| Recipe | Tier | Scope |
|---|---|---|
hello-world (planned upstream) | Core | First Connect call: create, add content, output |
multi-page (planned upstream) | Core | Multi-page document over Connect |
image-embedding (planned upstream) | Core | Embed an image over Connect |
html-table (planned upstream) | Core | Render an HTML table over Connect |
font-typography (planned upstream) | Core | Fonts and typography over Connect |
exception-aware (planned upstream) | Core | Exception-aware tool calls |
environment-diagnostics (planned upstream) | Core | Environment diagnostics tools |
layout-inspection (planned upstream) | Core | Inspect layout without rendering |
worker-safe (planned upstream) | Core | Worker-safe batch usage |
output-approval (planned upstream) | Core | The human-in-the-loop output gate |
event-hooks (planned upstream) | Core | Lifecycle event hooks |
fill-pdf-form (planned upstream) | Pro | Fill a PDF form over Connect |
extract-text-content (planned upstream) | Pro | Extract text content over Connect |
digital-signature (planned upstream) | Pro | Sign a PDF (PAdES B-B and B-T) over Connect |
accessibility-check (planned upstream) | Pro | PDF/UA accessibility check |
pii-redaction (planned upstream) | Enterprise | Remove detected personal data from the text layer (destructive) |
aria-tagged-pdf (planned upstream) | Pro | Map ARIA landmark roles to tagged structure |
figure-caption (planned upstream) | Pro | Accessible Figure with a nested Caption |
aria-noteref-pattern (planned upstream) | Pro | Footnote reference and body pattern |
compliance-check (planned upstream) | Enterprise | Run a named-standard check |
forensic-analysis (planned upstream) | Enterprise | Forensic analysis of a signed PDF |
ltv-health-check (planned upstream) | Enterprise | LTV health check (B-LT/B-LTA, Enterprise-only) |
batch-compliance (planned upstream) | Enterprise | Batch standards check |
ai-ready-certification (planned upstream) | Enterprise | AI-readiness check (not a certification) |
page-artifacts (planned upstream) | Enterprise | Mark pagination chrome as artifacts |
conformance-mode (planned upstream) | Enterprise | Select a conformance mode (intended to conform; a validator decides) |
cjk-vertical-writing (planned upstream) | Enterprise | CJK vertical writing metrics |
opentelemetry (planned upstream) | Core | Observe Connect with OpenTelemetry |
tagged-pdf-tutorial (planned upstream) | Core | Tagged PDF tutorial (intended to conform; veraPDF decides) |
The slug expresses the recipe’s intent in kebab-case with a single trailing slash: no numeric prefix, no version number, and no file extension. A recipe slug does not change after publication, and a moved slug carries a redirect.
Conformance and certification boundary
Section titled “Conformance and certification boundary”Several recipes touch standards (PDF/UA-2, PDF/A-4, PAdES). The Connect cookbook treats support for a standard as support, never as conformance or certification. The engine produces output intended to conform, and an independent validator (for example veraPDF) determines conformance. The AI-readiness recipe is a readiness check, not a certification. The LTV recipe’s long-term-validation material is an Enterprise-only capability. Its presence in a document is a capability the document carries, not a guarantee of indefinite signature validity. Each affected recipe restates these boundaries in full. This index only notes that they exist and points to where they are derived, instead of re-deriving them here.
See also
Section titled “See also”- Recipe conventions — the contract every Connect recipe follows.
- Integration cookbook — the ecosystem-wide package and integration reference, where Connect is the network service.