跳到內容

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 是其中的網路服務。