Skip to main content
Glama
pdfgate

PDFGate MCP Server

Official
by pdfgate

create_webhook

Set up a webhook subscription to receive PDFGate event notifications. Provide an HTTPS endpoint and event types; a signing secret is returned for verifying incoming signatures.

Instructions

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

Input Schema

TableJSON 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.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"
      +]
  2. 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"
      +]
  3. First observedv1.0.1

TDQS

A3.6/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 behavioral disclosure burden. It adds a valuable caution about the signing secret appearing in the response and advises secure storage – a genuinely useful non-obvious detail. However, it omits other behavioral traits like idempotency, permission requirements, or failure modes, so it only partially satisfies this dimension.

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?

The description is two concise sentences with no filler. The primary purpose is front-loaded in the first sentence, and the second sentence delivers the critical security note about the signing secret. Every word earns its place, making it well-structured for quick agent comprehension.

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 create tool with fully documented parameters and no output schema, the description covers the essential context: it creates a subscription and discloses the most important response detail (signing secret). The absence of output schema is mitigated by this key response note. It could go further by mentioning the webhook ID or verification process, but it is sufficiently complete for correct invocation.

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?

The input schema already describes all three parameters with 100% coverage (url format, eventTypes enums, description label). The description adds no parameter-level meaning beyond the schema, so the baseline score of 3 is appropriate. It does not explain how to choose eventTypes or what the url should be, but the schema already covers that.

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?

The description opens with 'Create a PDFGate webhook subscription' – a specific verb and resource that unambiguously identifies the operation. It naturally distinguishes itself from sibling tools like get_webhook and delete_webhook, and the mention of the signing secret adds a concrete outcome, so an agent can grasp the tool's role without opening the schema.

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 gives no guidance on when to use this tool versus alternatives. It does not explain that this is the go-to for subscribing to event notifications, nor does it mention any prerequisites, exclusions, or when to prefer get_webhook/delete_webhook. The usage is only implied by the verb 'create', which is minimal.

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