PDFGate

Gere documentos, processe PDFs e gerencie fluxos de trabalho de assinatura eletrônica usando a API do PDFGate.

Documentação

Servidor MCP PDFGate

Servidor Model Context Protocol (MCP) para a API PDFGate. Permite que assistentes de IA gerem PDFs, gerenciem documentos e lidem com assinaturas eletrônicas.

Instalação

Adicione o seguinte à configuração do seu cliente MCP:

{
  "mcpServers": {
    "pdfgate": {
      "command": "npx",
      "args": ["-y", "@pdfgate/mcp-server"],
      "env": {
        "PDFGATE_API_KEY": "your_api_key_here"
      }
    }
  }
}

Servidor hospedado (remoto)

Se preferir não executar nada localmente, também hospedamos o servidor MCP, para que você possa conectar-se diretamente a ele — sem npx, sem processo local. Aponte qualquer cliente que suporte servidores MCP remotos (Streamable HTTP) para:

https://mcp.pdfgate.com/server

Você pode autenticar de duas maneiras.

Opção 1 — OAuth

Para clientes que suportam servidores MCP remotos com OAuth (como Claude e ChatGPT), adicione o servidor apenas pela URL e faça login pelo seu navegador. Não há chave para copiar ou armazenar: o cliente se registra, envia você ao painel da PDFGate para aprovar o acesso e recebe automaticamente um token com escopo definido.

{
  "mcpServers": {
    "pdfgate": {
      "type": "http",
      "url": "https://mcp.pdfgate.com/server"
    }
  }
}

Muitos clientes permitem adicionar isso pela interface em vez de um arquivo de configuração — por exemplo, no Claude: Configurações → Conectores → Adicionar conector personalizado e, em seguida, insira a URL acima. As sessões OAuth são executadas na sua conta de produção; para o sandbox, use um X-API-KEY com uma chave test_.

Opção 2 — Chave de API

Envie sua chave no cabeçalho X-API-KEY:

{
  "mcpServers": {
    "pdfgate": {
      "type": "http",
      "url": "https://mcp.pdfgate.com/server",
      "headers": {
        "X-API-KEY": "your_api_key_here"
      }
    }
  }
}

Chaves live_ usam produção e chaves test_ usam o sandbox — o ambiente é selecionado automaticamente a partir da chave.

O servidor hospedado fornece o conjunto completo de ferramentas da PDFGate (geração de PDF, processamento, campos de formulário, assinaturas eletrônicas e webhooks). Os nomes exatos dos campos de configuração do cliente (por exemplo, type / transport, headers) podem variar conforme o cliente MCP.

Como obter uma chave de API

Cadastre-se em pdfgate.com para obter sua chave de API.

  • Chaves que começam com live_ conectam-se ao ambiente de produção
  • Chaves que começam com test_ conectam-se ao ambiente sandbox

Ferramentas

Operações de PDF

FerramentaDescrição
generate_pdfGerar um PDF a partir de uma URL ou HTML bruto
upload_fileEnviar um arquivo PDF local ou de uma URL
get_documentRecuperar metadados do documento e uma URL de download atualizada
download_fileBaixar os bytes brutos do PDF de um documento armazenado
delete_documentExcluir um documento
flatten_pdfAchatar um PDF interativo em um arquivo estático e não editável
extract_form_dataExtrair valores de campos de formulário de um PDF preenchível
add_form_fieldsAdicionar campos de formulário interativos a um PDF (tags de espaço reservado ou posições explícitas)
compress_pdfComprimir um PDF para reduzir o tamanho do arquivo
protect_pdfCriptografar um PDF com senha e restrições de permissão
watermark_pdfAplicar uma marca d'água de texto ou imagem a um PDF

Assinaturas Eletrônicas

FerramentaDescrição
create_envelopeCriar um envelope de assinatura a partir de um ou mais documentos
send_envelopeEnviar um envelope criado aos destinatários
get_envelopeObter o status atual de um envelope
void_envelopeAnular um envelope para que não possa mais ser assinado
delete_envelopeExcluir um envelope e remover seus documentos assinados
create_embed_linkCriar um link de assinatura de curta duração para um destinatário incorporado

Destinatários

FerramentaDescrição
create_recipientArmazenar um destinatário para reutilização em vários envelopes
list_recipientsListar destinatários armazenados por e-mail
get_recipientRecuperar um destinatário armazenado por ID
update_recipientAtualizar o nome ou os metadados de um destinatário armazenado

Gerenciamento de Webhooks

FerramentaDescrição
create_webhookAssinar eventos da PDFGate
get_webhookRecuperar uma assinatura de webhook por ID
delete_webhookRemover uma assinatura de webhook

Gatilhos de Webhook

O servidor escuta eventos recebidos da PDFGate na porta 3599 por padrão. Para receber eventos:

  1. Exponha a porta 3599 para a internet (por exemplo, via ngrok)
  2. Use a ferramenta create_webhook para registrar sua URL pública

Eventos suportados:

EventoDescrição
envelope.sentE-mails de solicitação de assinatura foram enviados aos destinatários
envelope.completedTodos os documentos no envelope foram assinados
envelope.expiredO envelope expirou antes que todos os documentos fossem assinados
envelope.document.completedUm único documento dentro do envelope foi totalmente assinado
envelope.recipient.signedUm destinatário assinou um documento no envelope
envelope.voidedO envelope foi anulado pelo remetente
envelope.deletedO envelope foi excluído

Os eventos recebidos estão disponíveis por meio do recurso MCP pdfgate://events e são enviados ao cliente em tempo real.

Variáveis de ambiente

VariávelObrigatóriaPadrãoDescrição
PDFGATE_API_KEYSim—Sua chave de API da PDFGate
PDFGATE_WEBHOOK_PORTNão3599Porta para o ouvinte de webhook

smithery badge