Skip to main content
Glama
PDFGate MCP Server

PDFGate MCP Server

Official
by pdfgate

create_webhook

Register an HTTPS endpoint to receive PDFGate envelope and signature events, returning a signing secret to verify incoming webhook payloads.

Instructions

Create a PDFGate webhook subscription. The response includes a signing secret — store it securely to verify incoming event signatures.

Input Schema

NameRequiredDescriptionDefault
urlYesThe HTTPS endpoint that will receive webhook events
eventTypesYesEvent types to subscribe to
descriptionNoOptional label to identify this webhook

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.5.0
    • changedInput schema / properties / eventTypes / items / enum
      Previous value: -[
      -  "envelope.sent",
      -  "envelope.completed",
      -  "envelope.expired",
      -  "envelope.voided",
      -  "envelope.deleted",
      -  "envelope.recipient.signed",
      -  "envelope.recipient.activated",
      -  "envelope.document.completed"
      -]New value: +[
      +  "envelope.sent",
      +  "envelope.completed",
      +  "envelope.expired",
      +  "envelope.voided",
      +  "envelope.deleted",
      +  "envelope.recipient.signed",
      +  "envelope.recipient.activated",
      +  "envelope.document.completed",
      +  "recipient.signature.enrolled",
      +  "recipient.signature.revoked"
      +]
  2. Changed1 schema field changedv1.4.0
    • changedInput schema / properties / eventTypes / items / enum
      Previous value: -[
      -  "envelope.sent",
      -  "envelope.completed",
      -  "envelope.expired",
      -  "envelope.voided",
      -  "envelope.deleted",
      -  "envelope.recipient.signed",
      -  "envelope.document.completed"
      -]New value: +[
      +  "envelope.sent",
      +  "envelope.completed",
      +  "envelope.expired",
      +  "envelope.voided",
      +  "envelope.deleted",
      +  "envelope.recipient.signed",
      +  "envelope.recipient.activated",
      +  "envelope.document.completed"
      +]
  3. Changed1 schema field changedv1.2.0
    • changedInput schema / properties / eventTypes / items / enum
      Previous value: -[
      -  "envelope.sent",
      -  "envelope.completed",
      -  "envelope.expired",
      -  "envelope.document.completed"
      -]New value: +[
      +  "envelope.sent",
      +  "envelope.completed",
      +  "envelope.expired",
      +  "envelope.voided",
      +  "envelope.deleted",
      +  "envelope.recipient.signed",
      +  "envelope.document.completed"
      +]
  4. First observedv1.0.1

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It does add genuinely valuable behavior: the response contains a signing secret that must be stored to verify event signatures, implying the secret is surfaced only at creation time. However, it omits whether duplicate subscriptions to the same URL are allowed, whether URL validation failures surface as errors, and whether the subscription is active immediately.

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, front-loaded with the action and followed by the one piece of post-call information an agent cannot recover later. No filler or redundant restatement of the schema.

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

Completeness3/5

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

For a three-parameter creation tool with no output schema, the description covers the essential return-value caveat (the signing secret) but leaves out operational context such as idempotency, duplicate handling, and when a subscription is the right approach versus polling with get_webhook.

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%, so all three parameters — url, eventTypes, and description — are already documented with meaningful text, including the HTTPS requirement and the event-type enum. The description adds no additional parameter meaning beyond the schema, so the baseline of 3 applies.

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

Purpose4/5

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

States a specific verb and resource ('Create a PDFGate webhook subscription'), which cleanly distinguishes it from the get_webhook and delete_webhook siblings. It doesn't explicitly name those siblings, but the verb makes the distinction unambiguous.

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

Usage Guidelines2/5

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

The description never says when to use this tool versus alternatives, nor does it state prerequisites such as requiring an HTTPS endpoint, a verified domain, or a plan limit on subscription count. An agent must infer the usage context entirely from the name.

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