PDFGate

PDFGate MCP 服务

用于 PDFGate API 的模型上下文协议（MCP）服务。支持 AI 助手生成 PDF、管理文档和处理电子签名。

安装

将以下内容添加到 MCP 客户端配置中：

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

托管服务（远程）

如果你不想在本地运行任何内容，我们也托管了 MCP 服务，你可以直接连接，无需 npx，也无需运行本地进程。将任何支持远程（Streamable HTTP）MCP 服务的客户端指向：

https://mcp.pdfgate.com/server

你可以通过两种方式进行身份验证。

选项 1 — OAuth

对于支持通过 OAuth 连接远程 MCP 服务的客户端（例如 Claude 和 ChatGPT），只需使用服务 URL 添加服务，然后通过浏览器登录。无需复制或保存密钥：客户端会自行注册，将你带到 PDFGate 控制面板批准访问，并自动获取作用域受限的令牌。

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

许多客户端支持通过界面添加服务，而不是编辑配置文件。例如，在 Claude 中，选择 Settings → Connectors → Add custom connector，然后输入上面的 URL。OAuth 会话使用你的生产账户；要使用沙盒，请使用带有 test_ 密钥的 X-API-KEY。

选项 2 — API 密钥

在 X-API-KEY 标头中传入密钥：

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

live_ 密钥用于生产环境，test_ 密钥用于沙盒；系统会根据密钥自动选择环境。

托管服务提供完整的 PDFGate 工具集（PDF 生成、处理、表单字段、电子签名和 Webhook）。具体的客户端配置字段名称（例如 type / transport、headers）可能因 MCP 客户端而异。

获取 API 密钥

在 pdfgate.com 注册以获取 API 密钥。

• 以 live_ 开头的密钥连接到生产环境
• 以 test_ 开头的密钥连接到沙盒环境

工具

PDF 操作

工具	描述
generate_pdf	从 URL 或原始 HTML 生成 PDF
upload_file	上传本地 PDF 文件或从 URL 上传文件
get_document	获取文档元数据和新的下载 URL
download_file	下载已存储文档的原始 PDF 字节数据
delete_document	删除文档
flatten_pdf	将交互式 PDF 展平为静态、不可编辑的文件
extract_form_data	从可填写的 PDF 中提取表单字段值
add_form_fields	向 PDF 添加交互式表单字段（占位符标签或指定位置）
compress_pdf	压缩 PDF 以减小文件大小
protect_pdf	使用密码和权限限制加密 PDF
watermark_pdf	为 PDF 添加文本或图片水印

电子签名

工具	描述
create_envelope	从一个或多个文档创建签署信封
send_envelope	将已创建的信封发送给收件人
get_envelope	获取信封的当前状态
void_envelope	作废信封，使其无法再被签署
delete_envelope	删除信封并移除其中已签署的文档
create_embed_link	为嵌入式收件人创建短时有效的签署链接

收件人

工具	描述
create_recipient	保存收件人，以便在多个信封中重复使用
list_recipients	按电子邮件地址列出已保存的收件人
get_recipient	按 ID 获取已保存的收件人
update_recipient	更新已保存收件人的姓名或元数据

Webhook 管理

工具	描述
create_webhook	订阅 PDFGate 事件
get_webhook	按 ID 获取 Webhook 订阅
delete_webhook	移除 Webhook 订阅

Webhook 触发器

服务器默认在端口 3599 上监听传入的 PDFGate 事件。要接收事件：

1. 将端口 3599 暴露到互联网（例如通过 ngrok）
2. 使用 create_webhook 工具注册你的公共 URL

支持的事件：

事件	描述
envelope.sent	已向收件人发送签署请求邮件
envelope.completed	信封中的所有文档均已签署
envelope.expired	信封在所有文档签署完毕前已过期
envelope.document.completed	信封中的单份文档已完成签署
envelope.recipient.signed	收件人已签署信封中的一份文档
envelope.voided	发送方已作废该信封
envelope.deleted	该信封已删除

收到的事件可通过 pdfgate://events MCP 资源获取，并实时推送到客户端。

环境变量

变量	必填	默认值	描述
PDFGATE_API_KEY	是	—	你的 PDFGate API 密钥
PDFGATE_WEBHOOK_PORT	否	3599	Webhook 监听器的端口

---