Docs
EN
Sign up

MCP reference

Connect your AI assistant to ShipPDF to work with your workspace’s templates and generate PDFs through the Model Context Protocol. ShipPDF provides the template schemas, authoring rules, and PDF generation tools the assistant needs to carry out your request.

The remote server URL is https://mcp.shippdf.com. Start with authentication, then choose the workflow you need.

GuideWhat you will learn
AuthenticationUse an Authorization header or OAuth, and connect ChatGPT, Claude Desktop, or Codex.
Capabilities and permissionsBrowse available tools, map them to API scopes, and guide the assistant with accurate workspace data.
Generate a PDF from an existing templateFind a published template, supply its data, and retrieve the finished PDF.
Author a template with AICreate a draft, inspect and edit it, then publish a reusable template.
Limits and errorsUnderstand rate limits, validation errors, conflicts, and retries.

How MCP connects to ShipPDF

ShipPDF uses Streamable HTTP with JSON-RPC 2.0 request/response. Your client calls a tool and receives its result; the server does not push messages. A plain GET to the endpoint returns 405, so opening the URL in a browser is not a connection test.

The server negotiates protocol versions 2025-06-18, 2025-03-26, and 2024-11-05. Use a client that supports remote MCP servers, or a local bridge if your client only supports stdio.

Your connection belongs to a workspace. Its permissions determine the templates and tools your assistant can access. PDF generation uses the same published templates and workspace credits as the REST API.