Overview
What is PDFGate?
PDFGate is a Model Context Protocol (MCP) server that integrates with the PDFGate API. It enables AI assistants to generate PDFs, manage documents, and handle e-signatures.
How to use PDFGate?
Add the server to your MCP client configuration with the command npx -y @pdfgate/mcp-server and set the PDFGATE_API_KEY environment variable. Obtain an API key by signing up at pdfgate.com – keys starting with live_ connect to the production environment, test_ to the sandbox.
Key features of PDFGate
- Generate PDFs from a URL or raw HTML
- Upload, retrieve, and delete documents
- Flatten, compress, protect, and watermark PDFs
- Extract form field values from fillable PDFs
- Create, send, and track e‑signature envelopes
- Manage webhook subscriptions for events
Use cases of PDFGate
- Generate PDF invoices or reports from HTML templates
- Upload and manage documents in a document workflow
- Send documents for e‑signature and track completion status
- Automate PDF processing such as compression or watermarking
- Receive real‑time notifications on envelope events via webhooks
FAQ from PDFGate
How do I get started with PDFGate?
Sign up at pdfgate.com to get an API key. Keys starting with live_ connect to production, test_ to the sandbox environment.
What tools does PDFGate provide?
PDF tools: generate_pdf, upload_pdf, get_document, delete_document, flatten_pdf, extract_pdf_form_data, compress_pdf, protect_pdf, watermark_pdf. E‑signature tools: create_envelope, send_envelope, get_envelope. Webhooks: create_webhook, delete_webhook.
How can I receive webhook events?
Expose the webhook port (default 3599) to the internet (e.g., via ngrok), then use the create_webhook tool to register your public URL. Events are available via the pdfgate://events resource and pushed in real time.
What events can I subscribe to?
Supported events: envelope.sent, envelope.completed, envelope.expired, and envelope.document.completed.
Is there a sandbox environment for testing?
Yes. Use an API key starting with test_ to connect to the PDFGate sandbox environment.
