Skip to main content
Glama
pdfgate

PDFGate MCP Server

Official
by pdfgate
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

create_envelope

Create a signing envelope from existing PDFGate documents, assign recipients with signing order, and prepare it for dispatch to collect e-signatures.

Instructions

Create a signing envelope from one or more existing PDFGate documents. Each recipient is given either as email and name or as the recipientId of a stored recipient. Recipients marked embedded sign inside your application via create_embed_link and receive no emails. Use signingOrder to make recipients sign in sequence. Returns an envelope in 'created' status; call send_envelope to dispatch signing emails.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
metadataNoCustom metadata to attach
documentsYesDocuments to include in the envelope
expiresInDaysNoDays until the envelope and its signing links expire, counted from creation. Defaults to the account's envelope expiration setting.
requesterNameYesName of the user or system creating the envelope

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.4.0
    • addedInput schema / properties / documents / items / properties / recipients / items / properties / signingOrder
      Added value: +{
+  "description": "Signing order of the recipient, starting from 1. Recipients sign one after another in this order and a recipient is activated once everyone with a lower value has signed. Recipients with the same value can sign in parallel. Provide it for every recipient of a document or for none. Omitted, all recipients can sign immediately",
+  "minimum": 1,
+  "type": "integer"
+}
  2. Changed5 schema fields changedv1.3.0
    • changedInput schema / properties / documents / items / properties / recipients / items / properties / email / description
      Previous value: -"Recipient email address"New value: +"Recipient email address. Required when recipientId is not provided"
    • addedInput schema / properties / documents / items / properties / recipients / items / properties / embedded
      Added value: +{
+  "description": "Embedded recipients sign inside your own application through a short-lived embed link and receive no emails from PDFGate",
+  "type": "boolean"
+}
    • changedInput schema / properties / documents / items / properties / recipients / items / properties / name / description
      Previous value: -"Recipient display name"New value: +"Recipient display name. Required when recipientId is not provided"
    • addedInput schema / properties / documents / items / properties / recipients / items / properties / recipientId
      Added value: +{
+  "description": "ID of a stored recipient to reuse. Provide either recipientId or email and name, never both",
+  "type": "string"
+}
    • removedInput schema / properties / documents / items / properties / recipients / items / required
      Removed value: -[
-  "email",
-  "name"
-]
  3. Changed4 schema fields changedv1.2.0
    • changedInput schema / properties / documents / items / properties / recipients / items / properties / reminderAttempts / description
      Previous value: -"Maximum number of reminder emails"New value: +"Maximum number of reminder emails (defaults to 5)"
    • addedInput schema / properties / documents / items / properties / recipients / items / properties / reminderAttempts / maximum
      Added value: +10
    • addedInput schema / properties / documents / items / properties / recipients / items / properties / reminderAttempts / minimum
      Added value: +1
    • addedInput schema / properties / expiresInDays
      Added value: +{
+  "description": "Days until the envelope and its signing links expire, counted from creation. Defaults to the account's envelope expiration setting.",
+  "maximum": 90,
+  "minimum": 1,
+  "type": "integer"
+}
  4. First observedv1.0.1

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses that the envelope is returned in 'created' status and that no emails are sent until send_envelope is called. Also notes embedded recipients receive no emails. However, it does not cover error handling, permissions, or side effects on source documents. With no annotations, the description carries the burden, and it does a moderate job.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with no filler. The main purpose is front-loaded, and the workflow (create then send) is clearly stated. Every sentence earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with nested objects and many parameters, the schema is exhaustive. The description covers the creation workflow and the need to call send_envelope, and it states the returned status. It does not explain the full return structure (no output schema), but it is complete enough for an agent to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with detailed parameter descriptions. The description adds high-level context (e.g., embedded recipients use create_embed_link, signingOrder semantics) but does not duplicate parameter details. It adds some value but is not essential given the schema's thoroughness.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Create') and resource ('a signing envelope') and explicitly distinguishes from sibling send_envelope by noting that dispatch is separate. It also references embedded signing via create_embed_link, clarifying scope and differentiating from other tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit usage context: embedded recipients use create_embed_link and receive no emails; signingOrder controls sequence; and it instructs to call send_envelope to dispatch emails. This gives clear when-to-use and when-to-follow-up guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools