跳转到内容

Connect 食谱

NextPDF Connect 通过 Model Context Protocol、REST API 与 gRPC 服务,将 NextPDF 引擎开放给远程调用方与 AI 系统。Connect 食谱聚合了该接口的各项任务食谱,而本页就是它的索引。它记录每个食谱占用的 slug,以及阅读每个食谱时依据的层级与传输边界。由于它是索引,因此不对任何食谱的行为作出主张。每个食谱页面都在 nextpdf/server 仓库的 docs/public/ 下编写,拥有自身的主张,并由聚合器在保留来源出处的情况下拉入本网站。

若要了解每个 Connect 食谱遵循的契约,请阅读 食谱惯例。若要了解横跨整个生态系统的集成全貌,请阅读 集成食谱

Connect 部署的工具集是在启动时计算的,并非预先固定。服务器的工具注册表会无条件注册核心工具。随后,它会通过 class_exists() 探测 Pro 与 Enterprise 提供者,并且只有在 nextpdf/premium 与服务器一同安装时,才注册它们的工具。因此,依赖某个 Pro 或 Enterprise 工具的食谱,只会在该工具已解析可用的部署上执行。在仅安装开源版本的环境中,该工具并不存在,调用会返回未知工具错误,而不会静默降级。每个食谱都会载明其层级,而本索引按层级将食谱分组,让你一眼就能看出特定部署支持哪些内容。

工具总数是该部署的运行时属性。本索引中的任何食谱或任何一行都不会主张某个固定数字。权威目录是服务器自身的工具目录,每个食谱都会链接到它。

你在所有三种传输上都以相同方式调用每个食谱——MCP 的 tools/call、REST 工具端点,或 gRPC 服务——因为它们共用同一个工具执行器。通过 HTTP 连接远程服务的食谱,会将传输失败与非成功的 HTTP 状态视为两种独立情况。PSR-18 客户端只有在完全无法发送请求时,才会抛出类型化的客户端异常——PSR-18 §4。相对地,4xx5xx 响应是调用方需要检查的正常返回值,而不是异常——PSR-18 §4。

每个食谱都位于 /cookbook/connect/<recipe>/。此表记录 slug、阅读该食谱时依据的层级,以及单行范围说明。这些食谱页面在 nextpdf/serverdocs/public/ 中编写,并在此处聚合。在某个页面上线之前,它的链接是一个前向引用。

食谱层级范围
hello-world(上游规划中)Core首次 Connect 调用:创建、添加内容、输出
multi-page(上游规划中)Core通过 Connect 生成多页文件
image-embedding(上游规划中)Core通过 Connect 嵌入图片
html-table(上游规划中)Core通过 Connect 渲染 HTML 表格
font-typography(上游规划中)Core通过 Connect 处理字体与排版
exception-aware(上游规划中)Core可感知异常的工具调用
environment-diagnostics(上游规划中)Core环境诊断工具
layout-inspection(上游规划中)Core在不渲染的情况下检查版面
worker-safe(上游规划中)CoreWorker 安全的批量用法
output-approval(上游规划中)Core人工介入的输出门控
event-hooks(上游规划中)Core生命周期事件钩子
fill-pdf-form(上游规划中)Pro通过 Connect 填写 PDF 表单
extract-text-content(上游规划中)Pro通过 Connect 提取文字内容
digital-signature(上游规划中)Pro通过 Connect 签署 PDF(PAdES B-B 与 B-T)
accessibility-check(上游规划中)ProPDF/UA 无障碍检查
pii-redaction(上游规划中)Enterprise从文本层移除检测到的个人数据(破坏性)
aria-tagged-pdf(上游规划中)Pro将 ARIA 地标角色映射到标记结构
figure-caption(上游规划中)Pro带嵌套 Caption 的无障碍 Figure
aria-noteref-pattern(上游规划中)Pro注脚引用与正文模式
compliance-check(上游规划中)Enterprise执行命名标准检查
forensic-analysis(上游规划中)Enterprise对已签署 PDF 进行取证分析
ltv-health-check(上游规划中)EnterpriseLTV 健康检查(B-LT/B-LTA,仅限 Enterprise)
batch-compliance(上游规划中)Enterprise批量标准检查
ai-ready-certification(上游规划中)EnterpriseAI 就绪检查(并非认证)
page-artifacts(上游规划中)Enterprise将分页装饰标记为构件
conformance-mode(上游规划中)Enterprise选择一种符合性模式(意在符合;由验证器判定)
cjk-vertical-writing(上游规划中)EnterpriseCJK 竖排书写度量
opentelemetry(上游规划中)Core使用 OpenTelemetry 观测 Connect
tagged-pdf-tutorial(上游规划中)Core标记式 PDF 教程(意在符合;由 veraPDF 判定)

slug 以 kebab-case 表达食谱意图,并带有一个尾随斜杠:不含数字前缀、不含版本号、不含扩展名。食谱 slug 一经发布便不会改变;被移动的 slug 会带有一个重定向。

有数个食谱涉及标准(PDF/UA-2、PDF/A-4、PAdES)。Connect 食谱会把对某标准的支持理解为支持,绝不理解为符合性或认证。引擎会产出意在符合的输出,而符合性则由独立验证器(例如 veraPDF)判定。AI 就绪食谱是一项就绪检查,并非认证。LTV 食谱的长期验证材料是一项仅限 Enterprise 的功能。它存在于文件中,表示该文件具备这项能力,并不是对签名无限期有效性的保证。每个受影响的食谱都会完整重述这些边界。本索引只说明它们的存在,并指向它们的推导来源,而不会在此重新推导。

  • 食谱惯例 — 每个 Connect 食谱遵循的契约。
  • 集成食谱 — 横跨整个生态系统的包与集成参考,Connect 是其中的网络服务。