Cookbook do Connect
O NextPDF Connect expõe o motor do NextPDF para chamadores remotos e sistemas de inteligência artificial (AI) por meio do Model Context Protocol (MCP), de uma API Representational State Transfer (REST) e de um serviço gRPC. O cookbook do Connect reúne as receitas orientadas a tarefas para essa superfície, e esta página é o índice delas. Ele registra o slug de cada receita, a tier à qual ela pertence e a fronteira de transporte que se aplica. Por ser um índice, esta página não faz nenhuma afirmação de comportamento sobre nenhuma receita. Cada página de receita é escrita no repositório nextpdf/server em docs/public/, é responsável pelas próprias afirmações e é trazida para este site pelo agregador com a procedência de origem intacta.
Para ver o contrato que toda receita do Connect segue, leia Convenções de receita. Para o panorama completo de integração do ecossistema, leia o Cookbook de integração.
Como a tier afeta o que você pode executar
Seção intitulada “Como a tier afeta o que você pode executar”Uma implantação do Connect calcula o conjunto de ferramentas na inicialização; ele não é definido com antecedência. O registro de ferramentas do servidor sempre inclui as ferramentas core. Em seguida, ele verifica os provedores Pro e Enterprise com class_exists() e registra as ferramentas deles apenas quando nextpdf/premium está instalado junto com o servidor. Uma receita que depende de uma ferramenta Pro ou Enterprise só é executada em uma implantação em que essa ferramenta foi resolvida. Em uma instalação somente open-source, a ferramenta fica ausente, e a chamada retorna um erro de ferramenta desconhecida em vez de degradar silenciosamente. Cada receita informa a própria tier, e este índice agrupa as receitas por tier para que você veja rapidamente o que uma implantação oferece.
A contagem total de ferramentas é uma propriedade de tempo de execução da implantação. Nenhuma receita e nenhuma linha deste índice afirma um número fixo. O catálogo de referência é o próprio catálogo de ferramentas do servidor, ao qual cada receita remete.
Transporte e modelo de erro
Seção intitulada “Transporte e modelo de erro”Você invoca cada receita da mesma forma nos três transportes: um tools/call do MCP, o endpoint de ferramenta REST ou o serviço gRPC. Eles compartilham um único executor de ferramentas. Receitas que alcançam um serviço remoto por Hypertext Transfer Protocol (HTTP) tratam falha de transporte e status HTTP de não sucesso como casos distintos. Um cliente PSR-18 lança uma exceção de cliente tipada somente quando não consegue enviar a requisição de forma alguma, conforme descrito em PSR-18 §4. Uma resposta 4xx ou 5xx é diferente: é um valor de retorno normal que o chamador inspeciona, não uma exceção, conforme descrito em PSR-18 §4.
O mapa de slugs das receitas
Seção intitulada “O mapa de slugs das receitas”Cada receita fica em /cookbook/connect/<recipe>/. A tabela registra o slug, a tier sob a qual a receita é lida e um escopo de uma linha. As páginas de receita são escritas na árvore docs/public/ do repositório nextpdf/server e publicadas neste site por meio do agregador.
| Receita | Tier | Escopo |
|---|---|---|
hello-world | Core | Primeira chamada do Connect: criar, adicionar conteúdo, gerar saída |
multi-page | Core | Documento de várias páginas pelo Connect |
image-embedding | Core | Incorporar uma imagem pelo Connect |
html-table | Core | Renderizar uma tabela HTML pelo Connect |
font-typography | Core | Fontes e tipografia pelo Connect |
exception-aware | Core | Chamadas de ferramenta cientes de exceções |
environment-diagnostics | Core | Ferramentas de diagnóstico de ambiente |
layout-inspection | Core | Inspecionar o layout sem renderizar |
worker-safe | Core | Uso em lote seguro para workers |
batch-pdf-generation-with-progress-tracking | Core | Gerar PDFs em lote com rastreamento de progresso assíncrono |
rest-invoice-end-to-end | Core | Uma fatura pelo REST: enviar, consultar, baixar, verificar localmente |
output-approval | Core | O portão de saída com humano no circuito |
mcp-agent-session | Core | Uma sessão de agente MCP capturada com a ida e volta da aprovação |
event-hooks | Core | Hooks de eventos de ciclo de vida |
fill-pdf-form | Pro | Preencher um formulário PDF pelo Connect |
extract-text-content | Pro | Extrair conteúdo de texto pelo Connect |
digital-signature | Pro | Assinar um PDF (PAdES B-B e B-T) pelo Connect |
accessibility-check | Pro | Verificação de acessibilidade PDF/UA |
pii-redaction | Enterprise | Remover dados pessoais detectados da camada de texto (destrutivo) |
aria-tagged-pdf | Pro | Mapear roles de marco ARIA para a estrutura marcada |
figure-caption | Pro | Figure acessível com uma Caption aninhada |
aria-noteref-pattern | Pro | Padrão de referência e corpo de nota de rodapé |
compliance-check | Enterprise | Executar uma verificação de padrão nomeado |
forensic-analysis | Enterprise | Análise forense de um PDF assinado |
ltv-health-check | Enterprise | Verificação de saúde LTV (B-LT/B-LTA, somente Enterprise) |
batch-compliance | Enterprise | Verificação de padrões em lote |
ai-ready-certification | Enterprise | Verificação de prontidão para AI (não é uma certificação) |
page-artifacts | Enterprise | Marcar elementos de paginação como artifacts |
conformance-mode | Enterprise | Selecionar um modo de conformidade (com a intenção de estar em conformidade; um validador decide) |
cjk-vertical-writing | Enterprise | Métricas de escrita vertical CJK |
opentelemetry | Core | Observar o Connect com OpenTelemetry |
tagged-pdf-tutorial | Core | Tutorial de PDF marcado (com a intenção de estar em conformidade; o veraPDF decide) |
O slug expressa a intenção da receita em kebab-case com uma única barra final: sem prefixo numérico, sem número de versão e sem extensão de arquivo. Um slug de receita não muda depois da publicação, e um slug movido carrega um redirecionamento.
Fronteira de conformidade e certificação
Seção intitulada “Fronteira de conformidade e certificação”Várias receitas tocam em padrões (PDF/UA-2, PDF/A-4, PAdES). O cookbook do Connect trata o suporte a um padrão como suporte, nunca como conformidade ou certificação. O motor produz saída com a intenção de estar em conformidade, e um validador independente (por exemplo, o veraPDF) determina a conformidade. A receita de prontidão para AI é uma verificação de prontidão, não uma certificação. O material de validação de longo prazo da receita LTV é um recurso exclusivo do Enterprise. A presença dele em um documento é um recurso que o documento carrega, não uma garantia de validade indefinida da assinatura. Cada receita afetada reafirma essas fronteiras por completo. Este índice apenas registra que elas existem e aponta de onde são derivadas, em vez de re-derivá-las aqui.
Veja também
Seção intitulada “Veja também”- Convenções de receita — o contrato que toda receita do Connect segue.
- Cookbook de integração — a referência de pacote e integração de todo o ecossistema, onde o Connect é o serviço de rede.