PDFGate MCP Server
OfficialYou can use this server to generate and manage PDFs, process documents, run e-signature workflows, manage recipients, and handle webhooks through PDFGate.
Generate PDFs from a URL or raw HTML with CSS/JS, headers/footers, margins, page size, orientation, metadata, and form fields.
Upload, retrieve, download, delete, flatten, compress, protect, watermark, and manage PDF form fields on stored documents.
Create, send, inspect, void, and delete e-signature envelopes, including ordered signing and embedded signing links.
Create, list, get, update, and delete reusable recipients and manage stored signatures.
Create, retrieve, and delete webhook subscriptions for envelope, recipient, and document events.
Connect either locally via npx or to the hosted remote MCP server using OAuth or an API key.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@PDFGate MCP ServerGenerate a PDF from this HTML: Hello"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
PDFGate MCP Server
Model Context Protocol (MCP) server for the PDFGate API. Enables AI assistants to generate PDFs, manage documents and handle e-signatures.
Installation
Add the following to your MCP client configuration:
{
"mcpServers": {
"pdfgate": {
"command": "npx",
"args": ["-y", "@pdfgate/mcp-server"],
"env": {
"PDFGATE_API_KEY": "your_api_key_here"
}
}
}
}Related MCP server: 1pdf
Hosted server (remote)
If you prefer not to run anything locally, we also host the MCP server, so you can
connect straight to it — no npx, no local process. Point any client that
supports remote (Streamable HTTP) MCP servers at:
https://mcp.pdfgate.com/serverYou can authenticate in two ways.
Option 1 — OAuth
For clients that support remote MCP servers with OAuth (such as Claude and ChatGPT), add the server by its URL alone and sign in through your browser. There is no key to copy or store: the client registers itself, sends you to the PDFGate dashboard to approve access, and receives a scoped token automatically.
{
"mcpServers": {
"pdfgate": {
"type": "http",
"url": "https://mcp.pdfgate.com/server"
}
}
}Many clients let you add this from their UI instead of a config file — for
example, in Claude: Settings → Connectors → Add custom connector, then enter
the URL above. OAuth sessions run against your production account; for the
sandbox, use an X-API-KEY with a test_ key.
Option 2 — API key
Pass your key in the X-API-KEY header:
{
"mcpServers": {
"pdfgate": {
"type": "http",
"url": "https://mcp.pdfgate.com/server",
"headers": {
"X-API-KEY": "your_api_key_here"
}
}
}
}live_ keys use production and test_ keys use the sandbox — the environment is
selected automatically from the key.
The hosted server provides the full PDFGate toolset (PDF generation, processing,
form fields, e-signatures and webhooks). The exact client config field names
(e.g. type / transport, headers) may vary by MCP client.
Getting an API key
Sign up at pdfgate.com to get your API key.
Keys starting with
live_connect to the production environmentKeys starting with
test_connect to the sandbox environment
Tools
PDF Operations
Tool | Description |
| Generate a PDF from a URL or raw HTML |
| Upload a local PDF file or from a URL |
| Retrieve document metadata and a fresh download URL |
| Download the raw PDF bytes of a stored document |
| Delete a document |
| Flatten an interactive PDF into a static, non-editable file |
| Extract form field values from a fillable PDF |
| Add interactive form fields to a PDF (placeholder tags or explicit positions) |
| Compress a PDF to reduce file size |
| Encrypt a PDF with a password and permission restrictions |
| Apply a text or image watermark to a PDF |
E-Signatures
Tool | Description |
| Create a signing envelope from one or more documents |
| Send a created envelope to recipients |
| Get the current status of an envelope |
| Void an envelope so it can no longer be signed |
| Delete an envelope and remove its signed documents |
| Create a short-lived signing link for an embedded recipient |
Recipients
Tool | Description |
| Store a recipient for reuse across envelopes |
| List stored recipients by email |
| Retrieve a stored recipient by ID |
| Update a stored recipient's name or metadata |
| Delete a stored recipient (personal data removed; blocked while a stored signature is active or pending) |
| Email a recipient an enrolment link to store a reusable signature for automatic signing |
| Remove a recipient's stored signature or cancel a pending enrolment |
Webhook Management
Tool | Description |
| Subscribe to PDFGate events |
| Retrieve a webhook subscription by ID |
| Remove a webhook subscription |
Webhook Triggers
The server listens for incoming PDFGate events on port 3599 by default. To receive events:
Expose port
3599to the internet (e.g. via ngrok)Use the
create_webhooktool to register your public URL
Supported events:
Event | Description |
| Signing request emails have been dispatched to recipients |
| All documents in the envelope have been signed |
| The envelope expired before all documents were signed |
| A single document inside the envelope has been fully signed |
| A recipient has signed a document in the envelope |
| The envelope was voided by the sender |
| The envelope was deleted |
| A recipient completed the enrolment and stored a reusable signature for automatic signing |
| A recipient's stored signature was removed |
Received events are available via the pdfgate://events MCP resource and pushed to the client in real time.
Environment variables
Variable | Required | Default | Description |
| Yes | — | Your PDFGate API key |
| No |
| Port for the webhook listener |
Available Tools
27 toolsadd_form_fieldsAInspect
Add interactive form fields to a stored PDF — from placeholder tags (refined via fieldOverrides) and/or explicitly positioned fields.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Fields to add at explicit positions | |
| documentId | Yes | The document ID | |
| fieldOverrides | No | Per-field overrides keyed by field name | |
| preSignedUrlExpiresIn | No | Generate a fresh pre-signed download URL expiring in this many seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the transparency burden. It explains the two mechanisms for adding fields (placeholder tags and explicit positions), which is useful, but it does not disclose mutation semantics—such as whether existing fields are replaced, versioning behavior, or required permissions. The description adds partial context beyond the schema but leaves key behavioral details unspecified.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence that efficiently captures the core action and the two modes of operation. There is no redundant wording, and every clause contributes meaningful information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested objects for fields and overrides, no output schema, no annotations), the description covers the main use cases but does not mention result behavior or side effects. The parameter-rich schema compensates for many details, making the description adequately complete for a focused tool description, though it could be slightly more explicit about the outcome.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds value by clarifying that fieldOverrides refine placeholder tags, which is not obvious from the schema's generic 'Per-field overrides keyed by field name' description. It also aligns the 'fields' parameter with 'explicitly positioned fields', enhancing understanding beyond raw schema definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool adds interactive form fields to a stored PDF, using a specific verb ('Add') and resource ('stored PDF'). It also distinguishes two modes: from placeholder tags refined via fieldOverrides and explicitly positioned fields, which separates it from sibling tools like extract_form_data or flatten_pdf.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description conveys clear context for when to use this tool—when adding form fields to a PDF—by outlining the two supported input methods. It does not explicitly name alternatives or state when not to use it, but the purpose is unambiguous given the sibling tool names.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
compress_pdfAInspect
Compress/optimise a PDF to reduce file size without changing visual content.
| Name | Required | Description | Default |
|---|---|---|---|
| metadata | No | Custom metadata to attach | |
| linearize | No | Linearise the PDF to enable fast web view (first page renders sooner) | |
| documentId | Yes | The source document ID to compress | |
| preSignedUrlExpiresIn | No | Pre-signed download URL expiry in seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description bears full burden. It states the tool reduces size without visual changes, but does not disclose permissions needed, whether original document is affected, or any rate limits or side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single, well-structured sentence that front-loads the core purpose with zero wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple compression tool with one required parameter and good schema, description is adequate. Lacks details on return value or original document handling, but acceptable given tool simplicity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, providing full parameter documentation. Description adds no additional parameter meaning beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description uses specific verb 'compress/optimise' and resource 'PDF', clearly stating the action and outcome (reduce file size without changing visual content). This distinguishes it from siblings like flatten_pdf or protect_pdf.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description implies usage when file size reduction is needed, but does not provide explicit when-to-use, when-not-to-use, or mention of alternatives like flatten_pdf for structural changes.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_embed_linkAInspect
Create a short-lived signing URL for an embedded recipient, to be rendered in an iframe inside your application. The envelope must be in 'in_progress' status and the link expires after 10 minutes, so create it when the signer is ready (one link per signing session). On documents with a signingOrder the link can only be created once it is the recipient's turn; the envelope.recipient.activated webhook event signals that moment. When the session ends the iframe redirects to returnUrl with event (signing_complete, voided, expired or not_found), envelopeId, documentId and recipientId appended as query parameters; existing returnUrl query parameters are preserved.
| Name | Required | Description | Default |
|---|---|---|---|
| returnUrl | Yes | URL the signing session redirects to when it ends | |
| documentId | Yes | The envelope document ID (sourceDocumentId) | |
| envelopeId | Yes | The envelope ID | |
| recipientId | Yes | The recipient ID of the embedded recipient |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses the link expiry, envelope status prerequisite, signing-order restriction, and detailed redirect behavior including which query parameters are appended and that existing returnUrl parameters are preserved. This goes well beyond minimal expectations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but well-structured. It opens with the core purpose, then layers in constraints and behavior. Every sentence carries necessary information, and there is no filler or repetition of schema property names.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is highly complete for a four-parameter tool, covering preconditions, timing, expiry, and session-end behavior. The only minor gap is that it does not explicitly describe the direct response shape (e.g., that the signing URL is returned directly), and there is no output schema to fill that gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds extra meaning by explaining what happens to returnUrl (event, envelopeId, documentId, recipientId appended, existing query params preserved) and by contextualizing recipientId/envelopeId with the signing-order turn logic.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly says 'Create a short-lived signing URL for an embedded recipient, to be rendered in an iframe inside your application.' This is a specific verb, resource, and usage context. It clearly distinguishes this tool from siblings like create_webhook and create_recipient.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit usage conditions: the envelope must be in 'in_progress', the link expires after 10 minutes, create it when the signer is ready, one per signing session, and for signingOrder documents only when it is the recipient's turn, signaled by the envelope.recipient.activated webhook event. This is precise when-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_envelopeAInspect
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. A recipient signs through the hosted flow (emailed link), embedded signing (embedded: sign inside your application via create_embed_link, no emails) or automatic signing (autoSign: the stored signature of a recipient enrolled with request_recipient_signature is applied on their behalf, no signing session). Use signingOrder to make recipients sign in sequence. Returns an envelope in 'created' status; call send_envelope to dispatch signing emails.
| Name | Required | Description | Default |
|---|---|---|---|
| metadata | No | Custom metadata to attach | |
| documents | Yes | Documents to include in the envelope | |
| expiresInDays | No | Days until the envelope and its signing links expire, counted from creation. Defaults to the account's envelope expiration setting. | |
| requesterName | Yes | Name of the user or system creating the envelope |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the behavioral burden and does well: it discloses the created-status lifecycle, that emails are not dispatched until send_envelope is called, and the differences between hosted, embedded, and autoSign recipients. It still omits permission requirements and error/idempotency behavior, so it is strong but not exhaustive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and then efficiently explains recipient modes, sequencing, and the next lifecycle step. It is dense but appropriately sized for a complex nested create operation, with no wasted filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex nested create tool with no annotations or output schema, the description covers the key lifecycle, recipient modes, sequencing, and next step well. It does not describe auth/error behavior or the returned envelope fields, but the rich input schema covers parameter-level details, making those omissions minor.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already carries most parameter detail. The description adds useful meaning by explaining the three recipient signing modes, cross-referencing create_embed_link and request_recipient_signature, and clarifying the sequencing purpose of signingOrder.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: create a signing envelope from existing PDFGate documents. It clearly distinguishes the tool from lifecycle siblings such as send_envelope, void_envelope, and delete_envelope by explaining that it returns an envelope in 'created' status.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly tells the agent to call send_envelope afterward to dispatch signing emails, and it names create_embed_link for embedded signing and request_recipient_signature for automatic signing. It also explains when and how to use signingOrder for sequential signing, giving clear usage context and alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_recipientAInspect
Store a recipient in your account so envelopes can reference them by recipientId. Emails are not unique; every call creates a new recipient, so use list_recipients first when reuse is intended.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Recipient display name | |
| Yes | Recipient email address. Stored lowercased and cannot be changed later | ||
| metadata | No | Custom metadata to attach |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the disclosure burden and does meaningful work: it reveals non-unique emails, non-idempotent creation, and account scoping. It could also mention response shape or auth requirements, but the core side effects are clearly disclosed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The main purpose is front-loaded, and the critical reuse warning immediately follows, making the behavior easy for an agent to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple create operation, the description covers purpose, account scope, and the non-idempotency warning. Since there is no output schema, it could explicitly state that the response contains the new recipientId, so a small gap remains.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters well. The description adds context about non-unique emails and recipientId, but does not add new per-parameter meaning beyond what the schema supplies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Store') and resource ('a recipient') and explains why it exists: so envelopes can reference recipients by recipientId. It also distinguishes the tool from reuse-oriented flows by noting each call creates a new recipient.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells the agent to use list_recipients first when reuse is intended, and warns that emails are not unique. It does not explicitly contrast create_recipient with update_recipient, but the guidance for the main alternative is concrete and actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_webhookBInspect
Create a PDFGate webhook subscription. The response includes a signing secret — store it securely to verify incoming event signatures.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The HTTPS endpoint that will receive webhook events | |
| eventTypes | Yes | Event types to subscribe to | |
| description | No | Optional label to identify this webhook |
TDQS
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.
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.
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.
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.
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.
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.
delete_documentAInspect
Delete a PDFGate document.
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | The document ID to delete |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It merely says 'Delete' without disclosing that deletion is permanent, irreversible, or requires specific permissions. For a destructive action, this is a significant gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with no unnecessary words. It is front-loaded and immediately conveys the action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple and has no output schema, but the description is minimal. It lacks information about return values or side effects. While the core purpose is clear, the description does not fully prepare an agent for the tool's complete behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage with a single parameter. The description repeats the schema's description ('The document ID to delete') without adding extra meaning, such as format examples or constraints. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Delete a PDFGate document.' The verb 'delete' and the resource 'PDFGate document' are specific and distinct from sibling tools like upload_pdf, get_document, etc., which do not involve deletion.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance is given on when to use this tool versus alternatives. Although the tool is simple, there is no mention of prerequisites (e.g., check if document exists) or consequences (e.g., irreversibility). A score of 3 reflects the lack of such guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_envelopeAInspect
Permanently delete an envelope and the files it produced (signed documents and audit logs). Recipient data is anonymized and recipients lose access; source documents are not deleted. Only envelopes in 'draft', 'completed', 'expired', or 'voided' status can be deleted — void an active envelope first. Cannot be undone.
| Name | Required | Description | Default |
|---|---|---|---|
| envelopeId | Yes | The envelope ID to delete |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals permanent deletion, that signed documents and audit logs are removed, that recipient data is anonymized and access is lost, that source documents are untouched, and that the action cannot be undone. This is thorough for a destructive operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and information-dense: the primary action and primary consequence come first, followed by eligibility constraints, then the irreversibility warning. Every sentence carries meaningful information with no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter destructive tool with no output schema, the description covers the behavior, side effects, restrictions, and prerequisite action. Nothing essential for an agent to invoke the tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, with the only parameter 'envelopeId' described. The description adds no further formatting or semantic detail about the parameter itself, but since the schema already documents it, the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('delete') and resource ('envelope'), and immediately clarifies scope: it deletes the envelope plus its produced files (signed documents and audit logs). This differentiates it from siblings like delete_document and void_envelope, making the tool's purpose unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly lists which statuses are eligible ('draft', 'completed', 'expired', 'voided') and tells the agent to 'void an active envelope first', directly pointing to the correct alternative workflow (void_envelope) for active envelopes. This is clear when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_recipientAInspect
Delete a stored recipient from your account directory. The record is kept with its personal data removed (email, name, phone, metadata and any stored signature), so later reads return 404 and a new envelope to the same address creates a fresh recipient; envelopes already sent keep their own copy and are not affected. Rejected with a 400 error while the recipient has an active stored signature or a pending enrolment — call remove_recipient_signature first.
| Name | Required | Description | Default |
|---|---|---|---|
| recipientId | Yes | The recipient ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully carries behavioral disclosure: it states that the record is retained with personal data removed, later reads return 404, new envelopes create a fresh recipient, and already-sent envelopes are unaffected. It also discloses the 400 error condition and prerequisite action, giving the agent a rich understanding of side effects and failure modes.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the action, followed by consequences and error handling. It uses three dense but purposeful sentences without redundant filler, and every clause delivers useful operational information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter deletion tool with no annotations or output schema, the description covers purpose, side effects, data-retention behavior, dependent-object impact, and error prerequisite. Nothing essential for correct invocation appears to be missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% for the single recipientId parameter, so the schema already defines its meaning. The description adds no additional syntax or semantic detail about recipientId beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb 'Delete' and resource 'stored recipient from your account directory', making it clearly distinct from sibling tools such as create_recipient, list_recipients, and remove_recipient_signature. The scope is explicit enough that an agent can select it without opening other schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explains usage implicitly by describing the deletion effect and explicitly notes a rejection condition ('Rejected with a 400 error while ...') with the prerequisite alternative 'call remove_recipient_signature first'. It does not compare against update_recipient or delete_envelope, but the context and prerequisite cover the main decision point.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_webhookAInspect
Delete a PDFGate webhook subscription. Future events will no longer be delivered to the associated endpoint.
| Name | Required | Description | Default |
|---|---|---|---|
| webhookId | Yes | The webhook ID to delete |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses main consequence (stops event delivery), but no mention of authorization, idempotency, or reversibility. Adequate for a simple delete operation with no annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences, front-loaded with action, no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with one param and no output schema, description sufficiently covers purpose and immediate effect.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers parameter fully (100% coverage). Description adds no extra meaning beyond 'The webhook ID to delete'.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states action ('Delete a PDFGate webhook subscription') and consequence ('Future events will no longer be delivered'). Distinguishes from sibling 'create_webhook'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implied usage for deleting a webhook, but no explicit guidance on when to use vs. alternatives, prerequisites, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
download_fileAInspect
Download the raw PDF bytes of a stored document, returned as an embedded resource. For a shareable link instead, use get_document.
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | The document ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the burden. It discloses the return format ('embedded resource') which adds value, but it does not explicitly state that the operation is read-only, or mention authentication, error behavior, or any side effects. The word 'Download' implies a safe read, but this is not made explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with the action and resource front-loaded. The second sentence provides a helpful alternative. No unnecessary words or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple with one parameter and no output schema. The description covers what the tool does, the return type, and differentiates from get_document. It lacks edge-case details like invalid document IDs or permissions, but these are not critical for a straightforward download operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with a description for the only parameter (documentId = 'The document ID'). The tool description adds no additional parameter semantics beyond what the schema already provides, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Uses specific verb 'Download' and resource 'raw PDF bytes of a stored document', which clearly differentiates from sibling tool get_document that provides a shareable link. The purpose is unambiguous and distinct.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use this tool versus alternative: 'For a shareable link instead, use get_document.' This provides clear guidance on tool selection and contexts where this tool is preferred.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
extract_form_dataAInspect
Extract form field values from a fillable PDF. Returns a JSON object mapping field names to their values.
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | The document ID of the fillable PDF |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden of behavioral disclosure. It mentions the return value (a JSON object mapping fields to values), which adds some transparency, but it doesn't explicitly state whether the operation is read-only, if any side effects occur, or how errors are handled. The verb 'extract' implies a non-destructive read, but this is left implicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences long, front-loaded with the action, and contains zero fluff. Every word earns its place, making it highly concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (1 parameter, no output schema), the description adequately covers the primary behavior and return format. It doesn't specify error conditions or edge cases (e.g., non-fillable PDFs), but for a simple extraction tool this is a minor gap. The absence of a return schema is compensated by the explicit description of the JSON output.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% (single parameter documentId clearly described as 'The document ID of the fillable PDF'). The description adds no additional parameter semantics beyond what the schema already provides, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Extract' and the resource 'form field values from a fillable PDF', distinguishing it from sibling tools like flatten_pdf (which flattens fields) and add_form_fields (which adds fields). It unambiguously identifies the tool's core function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description offers no guidance on when to use this tool versus alternatives such as get_document or flatten_pdf. It doesn't mention prerequisites (e.g., the PDF must be fillable) or scenarios where this tool is preferred. No explicit when/when-not instructions are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
flatten_pdfAInspect
Flatten an interactive PDF into a static, non-editable PDF. Creates a new document; does not overwrite the original.
| Name | Required | Description | Default |
|---|---|---|---|
| metadata | No | Custom metadata to attach | |
| documentId | Yes | The source document ID to flatten | |
| preSignedUrlExpiresIn | No | Pre-signed download URL expiry in seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries the full burden. It discloses that the tool creates a new document and does not overwrite the original, which is a key behavioral trait. However, it does not mention permissions, side effects (e.g., form data removal), or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with two sentences that front-load the primary action and result. No redundant or unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a straightforward tool with no output schema, the description covers the essential behavior. It could mention what is returned (e.g., the new document ID) but is still fairly complete given the tool's simplicity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already explains all parameters. The description adds no extra semantic value beyond what is in the schema, resulting in a baseline score of 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool flattens an interactive PDF into a static, non-editable PDF. It uses specific verbs ('flatten' and 'creates') and distinguishes the action from sibling tools like compress_pdf or protect_pdf.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not explicitly guide when to use this tool vs alternatives. However, the purpose is clear enough that an agent could infer usage context. No exclusions or when-not-to-use guidance is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_pdfBInspect
Generate a PDF from a URL or raw HTML. Provide either 'url' or 'html', not both.
| Name | Required | Description | Default |
|---|---|---|---|
| css | No | CSS to inject before rendering | |
| url | No | Public URL to render as PDF | |
| html | No | Raw HTML string to render as PDF | |
| footer | No | HTML string for the page footer | |
| header | No | HTML string for the page header | |
| metadata | No | Custom metadata to attach | |
| marginTop | No | Top margin e.g. '10mm' | |
| javascript | No | JavaScript to inject before rendering | |
| marginLeft | No | Left margin | |
| marginRight | No | Right margin | |
| orientation | No | Page orientation (default: portrait) | |
| marginBottom | No | Bottom margin | |
| pageSizeType | No | Page size (default: a4) | |
| printBackground | No | Print background graphics (default: true) | |
| emulateMediaType | No | ||
| enableFormFields | No | Enable interactive PDF form fields from HTML | |
| waitForNetworkIdle | No | Wait for network idle before rendering | |
| preSignedUrlExpiresIn | No | Pre-signed download URL expiry in seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It only states the action without disclosing behavior like error handling, timeouts, authentication needs, or side effects. For a tool with 18 parameters and no output schema, this is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise (one sentence, 13 words) with no wasted words. It front-loads the core purpose and key constraint, making it easy for an agent to quickly grasp the tool's function.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (18 parameters, no output schema, many siblings), the description is too brief. It doesn't explain the output format, how to combine parameters, or provide an overview. The agent would lack information to use the tool effectively beyond basic usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is high (94%), so the schema already documents most parameters. The description adds value by highlighting the mutual exclusivity of url and html, which is not enforced in the schema. However, it does not elaborate on other parameters or their interactions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool generates a PDF from a URL or raw HTML, specifying the two primary inputs and the mutual exclusivity constraint. This distinguishes it from sibling tools like flatten_pdf or protect_pdf, which perform different PDF operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides basic guidance on parameter selection ('Provide either url or html, not both') but lacks information on when to use this tool versus alternatives like upload_pdf or get_document. No explicit when-not or context for choosing among siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_documentCInspect
Retrieve metadata for a stored PDFGate document by its ID.
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | The document ID | |
| preSignedUrlExpiresIn | No | Generate a fresh pre-signed download URL expiring in this many seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavioral traits. It states 'retrieve metadata' implying read-only, but omits the key behavior of generating a pre-signed download URL via the preSignedUrlExpiresIn parameter, which could have destructive implications if misinterpreted.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence of 11 words, concise and front-loaded. However, it omits important information, but that is a completeness issue, not a conciseness flaw.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given two parameters, no output schema, and no annotations, the description should cover the tool's functionality fully. It fails to mention the pre-signed URL generation and does not describe the returned metadata structure, leaving gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Although schema description coverage is 100%, the description adds no value beyond the schema. It fails to mention the preSignedUrlExpiresIn parameter, which is a significant optional feature, leaving the agent unaware of its purpose.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Retrieve' and the resource 'metadata for a stored PDFGate document by its ID'. It effectively distinguishes the tool from siblings like delete_document or upload_pdf by specifying metadata retrieval.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives such as get_envelope or other tools. No context on prerequisites, exclusions, or preferred scenarios is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_envelopeAInspect
Retrieve the current state of an envelope including its status, document progress, and per-recipient signing status. Each recipient carries an embedded boolean; embedded recipients have no signing link — mint one with create_embed_link instead. Recipients on ordered documents carry signingOrder and, once it is their turn, activatedAt. Each recipient also carries autoSign (signed automatically with their stored signature) and sendSignedCopy (emailed the signed document on completion) booleans.
| Name | Required | Description | Default |
|---|---|---|---|
| envelopeId | Yes | The envelope ID to retrieve |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden, and it does meaningful work by decoding the returned recipient fields (embedded, signingOrder, activatedAt, autoSign, sendSignedCopy) that an agent could not otherwise interpret. Gaps remain: it does not explicitly state this is a non-mutating read, nor describe auth requirements or what envelope-level status values exist.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The return-value summary is front-loaded and the recipient-field explanations are packed into two follow-up sentences, which is efficient given there is no output schema. A few phrases (the trailing autoSign/sendSignedCopy sentence) are dense but each carries real semantic weight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter read tool, the description compensates well for the missing output schema by explaining recipient-level fields and the embedded/link distinction. It is thinner on envelope-level return content (what 'document progress' actually contains) and on error behavior for unknown or deleted envelope IDs.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single parameter (envelopeId) at 100% schema description coverage, so the schema fully documents the input and the description adds nothing about it. The baseline of 3 applies since the schema does all the work and no additional format or provenance notes are offered.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource ('Retrieve the current state of an envelope') and enumerates what comes back: status, document progress, per-recipient signing status. It differentiates from create_embed_link but never contrasts with the neighboring get_recipient / list_recipients tools, so an agent must still infer which retrieval tool to pick.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is one explicit routing hint: for embedded recipients that lack a signing link, use create_embed_link instead. Otherwise there is no stated when-to-use vs get_recipient/list_recipients, and no mention of preconditions such as whether the envelope must be sent first. Usage is implied rather than guided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_recipientAInspect
Retrieve a stored recipient by ID. Once a stored signature was requested the response carries a signature object (status pending, active or revoked, plus requestedAt, adoptionMethod, enrolledAt, revokedAt, lastUsedAt and useCount); while the signature is active it also includes image, the signature as a PNG data URL, which can be very long.
| Name | Required | Description | Default |
|---|---|---|---|
| recipientId | Yes | The recipient ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description shoulders the full burden, and it delivers the most important behavioral detail: the response may include a signature object with status values and timestamps, and the image field is a potentially very long PNG data URL. It omits not-found/error behavior and authentication requirements, which keeps it below a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The response shape is front-loaded in the first sentence and the caveat about the oversized image field comes last where it matters. The field enumeration is dense but each item is informative, so it does not read as filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description steps in to explain the return shape, which is the main complexity for a getter of this kind. An agent has enough to call it and interpret the response, with only error paths left unstated.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with one required parameter, so the schema already documents it fully. The description adds no format or sourcing hints for recipientId, matching the baseline expectation when the schema does the work.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: retrieve a stored recipient by ID. The phrase 'by ID' distinguishes it from list_recipients and create_recipient, though it never names the sibling tools directly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The usage is implied by 'retrieve ... by ID' – single-recipient lookup – but does not state prerequisites, when to use it versus list_recipients, or what happens when the ID is unknown.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_webhookBInspect
Retrieve a PDFGate webhook subscription by its ID.
| Name | Required | Description | Default |
|---|---|---|---|
| webhookId | Yes | The webhook ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description must disclose behavioral traits. It states the tool retrieves a subscription, implying a read operation, and likely returns the webhook details; however, it does not mention whether the webhook must belong to the authenticated user, whether it returns a 404 for missing IDs, or any rate limits. The description adds minimal behavioral context beyond the verb 'retrieve'.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, under 15 words, and immediately states what the tool does and its key parameter. There is no filler or redundant detail.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (one required parameter, no output schema, no nested objects), the description is sufficient to understand the basic operation. However, the lack of usage guidance and behavioral transparency (e.g., error behavior) prevents a higher score, especially since no annotations offload that burden.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single parameter 'webhookId' has a schema description ('The webhook ID') and is required. Schema coverage is 100%, and the description's phrase 'by its ID' corroborates the parameter's role, adding no extra meaning but not detracting. Baseline is 3 for high coverage, and the alignment with the purpose earns a 4 because it reinforces the parameter's necessity.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the tool retrieves a webhook subscription by ID, which is clear and differentiates from siblings like create_webhook and delete_webhook. However, it does not specify whether the returned data includes the webhook's URL or events, but the core purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a straightforward when-to-use scenario (retrieve a webhook by ID) but provides no guidance on when not to use it or when to prefer alternatives, such as list operations. Given the sibling set includes other webhook operations, this lack of context is a gap.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_recipientsAInspect
List stored recipients with the given email (case-insensitive), oldest first.
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | Email to look up |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the transparency burden. It discloses important behavioral traits beyond the tool name: case-insensitive matching and ordering by oldest first. 'List' also clearly signals a read-only operation, though it does not describe return shape or empty-result behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The entire description is one efficient sentence. It front-loads the verb and resource, then adds the two most decision-relevant modifiers (case-insensitive, oldest first). There is no redundant or filler wording.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter read-only list tool with full schema coverage and no output schema, the description is largely complete. It explains what the tool does, how the parameter behaves, and the result ordering. It could mention pagination or limits, but that is a minor gap for this kind of tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already documents the email parameter fully with format and description, so the baseline is 3. The description adds value by specifying that matching is case-insensitive, which is a meaningful behavioral detail for the parameter not present in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'List', the resource 'stored recipients', and the key scoping condition ('with the given email'). It also adds meaningful specificity with 'case-insensitive' and 'oldest first', making it easy to distinguish from singular get_recipient or other recipient tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the use case: find all stored recipients matching a specific email. However, it does not explicitly say when to prefer this over get_recipient or other sibling tools, and no exclusion criteria or alternatives are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
protect_pdfAInspect
Encrypt a PDF with a password and optional permission restrictions. Produces a new document; the original is unchanged.
| Name | Required | Description | Default |
|---|---|---|---|
| metadata | No | Custom metadata to attach | |
| algorithm | No | Encryption algorithm (default: AES256) | |
| documentId | Yes | The source document ID to protect | |
| disableCopy | No | Prevent copying text | |
| disablePrint | No | Prevent printing | |
| userPassword | No | Password required to open the PDF | |
| ownerPassword | No | Full-control owner password; required when using AES256 with a userPassword | |
| disableEditing | No | Prevent editing | |
| encryptMetadata | No | Encrypt PDF metadata (default: false) | |
| preSignedUrlExpiresIn | No | Pre-signed download URL expiry in seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses that the tool is non-destructive (produces a new document, original unchanged), which is valuable behavioral context beyond the schema. With no annotations, this clarity is helpful, though it could mention more about permission requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core action, no wasted words. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 10 parameters, no output schema, and no annotations, the description is concise but lacks detail on return values (e.g., new document ID) and edge cases. It covers the essential function but leaves gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so parameters are well-documented. The description only adds high-level context about 'optional permission restrictions', not significantly beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool encrypts a PDF with a password and optional permission restrictions, and explicitly notes it produces a new document. This distinguishes it from siblings like compress_pdf or watermark_pdf.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for protecting PDFs but does not provide explicit guidance on when to use this tool versus alternatives like watermark_pdf or flatten_pdf. No exclusions or prerequisites are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
remove_recipient_signatureAInspect
Automatic signing: remove the stored signature of a recipient (signature.status becomes 'revoked' and the recipient.signature.revoked webhook fires) or cancel a pending enrolment so its link stops working. Envelopes already waiting on the automatic signature fall back to a signing link emailed to the recipient. Idempotent: a recipient without a stored signature is returned unchanged. Required before delete_recipient while a signature is active or an enrolment is pending.
| Name | Required | Description | Default |
|---|---|---|---|
| recipientId | Yes | The recipient ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations supplied, the description carries the full behavioral burden and does so well: it discloses the resulting state change (signature.status becomes 'revoked'), a webhook emission (recipient.signature.revoked), an outbound email side effect for waiting envelopes, and idempotency semantics ('a recipient without a stored signature is returned unchanged'). These are exactly the side effects an agent must know before calling a mutation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, each carrying distinct information (what it does, fallback behavior, idempotency, prerequisite), with the operation described first. Slightly dense with parenthetical webhook detail, but no sentence is filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter mutation with no annotations and no output schema, the description supplies everything an agent needs: state transitions, webhook and email side effects, idempotent return behavior, and the sequencing constraint against delete_recipient. Nothing material is left to inference.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single parameter is fully documented in the schema, so the baseline is 3. The description refers to 'a recipient' but adds no meaning beyond the schema, such as whether the recipientId must come from list_recipients or belongs to a specific envelope; it neither compensates nor detracts.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource ('remove the stored signature of a recipient') and explicitly covers the second mode of the operation ('cancel a pending enrolment'). It is unambiguous against siblings such as request_recipient_signature or delete_recipient because it states exactly what state changes it causes rather than just what it touches.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a concrete when-to-use rule ('Required before delete_recipient while a signature is active or an enrolment is pending') plus the consequence of not using it (envelopes fall back to an emailed signing link). It does not name a sibling alternative for the opposite intent, e.g. request_recipient_signature when you want to start an enrolment rather than cancel one, so it falls short of full routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
request_recipient_signatureAInspect
Automatic signing: email a stored recipient a link to store a reusable signature (they verify their email with a one-time code, accept the authorization text and type, draw or upload their signature). The link is valid for 7 days and calling this again replaces a pending request with a new link. Returns the recipient with signature.status 'pending'; once they complete the enrolment the recipient.signature.enrolled webhook fires and envelopes can set autoSign on this recipient. Rejected with a 400 error when the recipient has no email or already has an active stored signature (remove it first with remove_recipient_signature).
| Name | Required | Description | Default |
|---|---|---|---|
| recipientId | Yes | The recipient ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are supplied, so the description carries the full burden and does so: 7-day link validity, that re-calling replaces a pending request, the returned signature.status of 'pending', the recipient.signature.enrolled webhook firing on completion, and the two 400 rejection conditions. This is exactly the kind of out-of-band behavior an agent cannot infer from the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the action, then consequences, then error cases; every sentence informs. The parenthetical describing the signer's verification flow is the only part that could be trimmed without losing agent-relevant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema and no annotations, the description still covers return shape ('Returns the recipient with signature.status pending'), async completion via webhook, retry/idempotency behavior, and failure modes. Nothing an agent needs in order to call this correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter with 100% schema description coverage, so the schema already defines recipientId. The description adds useful preconditions on that value — the recipient must exist in storage and have an email — but does not add formatting or lookup detail beyond that.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with a specific verb and resource: 'email a stored recipient a link to store a reusable signature', and qualifies it as 'Automatic signing'. It also distinguishes the related operation by naming remove_recipient_signature as the prerequisite when a signature already exists.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a clear precondition context (recipient must be stored and have an email, must not already have an active stored signature) and routes the agent to remove_recipient_signature in that case. It doesn't explicitly frame when to prefer this over, say, sending an envelope, but the automatic-signing enrolment scenario is unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
send_envelopeAInspect
Send a created envelope to its recipients. PDFGate dispatches signing emails with secure, OTP-protected links that stay valid until the envelope expires. Embedded recipients receive no email; create their signing links with create_embed_link after sending. On documents with a signingOrder only the first recipients are emailed; later recipients are activated as earlier ones sign.
| Name | Required | Description | Default |
|---|---|---|---|
| envelopeId | Yes | The envelope ID to send |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden and provides strong detail: OTP-protected links, expiration, no email for embedded recipients, and signingOrder activation behavior. It does not disclose idempotency/error behavior or auth requirements, which is a minor gap for a send action with no annotation safety hints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the core action, followed by the two most decision-relevant behavioral nuances. There is no filler, and every sentence contributes unique operational information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter send action with no output schema, the description covers the invocation prerequisite, recipient handling, and signing-order behavior. The only additional material an agent might want is response/status detail, but that is unnecessary for correctly selecting and invoking this tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the only parameter, envelopeId, already has a clear description in the schema. The description adds no new semantic detail about the parameter beyond referring to the envelope itself, so it meets the baseline without exceeding it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening sentence, 'Send a created envelope to its recipients,' states a specific verb and resource and clearly separates this from envelope-creation, deletion, and helper tools. It further differentiates itself from create_embed_link by explaining that embedded recipients need a different flow.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit routing guidance: embedded recipients receive no email, and their links must be created with create_embed_link after sending. It also communicates the prerequisite state ('created envelope') and the signingOrder condition for staged emailing, so an agent knows exactly when and how to use the tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_recipientAInspect
Update a stored recipient's name or metadata. The email cannot be changed. Existing envelopes are not affected; they keep the recipient name they were created with.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New recipient display name | |
| metadata | No | Replacement custom metadata | |
| recipientId | Yes | The recipient ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden. It clearly states that the email is immutable and that existing envelopes retain the original recipient name, which is useful non-obvious behavior. It does not discuss authorization or reversibility, but the key side-effect disclosure is present.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences. The main action is front-loaded, and the second sentence earns its place by disclosing an important behavioral constraint. No redundant wording.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 3-parameter mutation tool with no annotations and no output schema, the description covers purpose, immutability, and side effects. The only notable omission is explicit routing to create_recipient when the recipient does not yet exist, though 'stored' hints at it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so each parameter is already documented. The description adds the high-level 'name or metadata' scope and the email exclusion, but doesn't add per-parameter detail beyond the schema, so a baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Update a stored recipient's name or metadata.' It clearly distinguishes this from creation tools by saying 'stored' and explicitly excludes the email field, leaving no ambiguity about the tool's scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'stored recipient' implies the tool is for existing recipients, setting it apart from create_recipient. It also gives a clear exclusion ('The email cannot be changed') and a side-effect boundary ('Existing envelopes are not affected'), giving the agent enough context to decide when to call it. It does not explicitly name an alternative tool, so a small gap remains.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
upload_fileAInspect
Upload a PDF to PDFGate so it can be referenced by other operations. Provide either 'filePath' (local path) or 'url'.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Publicly accessible URL of the PDF to upload | |
| filePath | No | Absolute local path to the PDF file to upload | |
| metadata | No | Custom metadata to attach | |
| preSignedUrlExpiresIn | No | Pre-signed download URL expiry in seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses the core behavior (upload and storage for later reference) but omits details like persistence duration, size limits, or whether re-uploading overwrites. It does not contradict itself but is minimal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, both purposeful. First states what it does and why; second clarifies the primary input choice. No wasted words, front-loaded with key information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the essential upload action and purpose but lacks detail on the return value (e.g., document ID for referencing) and does not mention optional parameters (metadata, preSignedUrlExpiresIn). Given the tool's simplicity and absence of output schema, it is adequate but not thorough.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers all parameters with descriptions, but the description adds critical semantics: it clarifies that either filePath or url must be provided (mutual exclusivity) and that filePath refers to a local path. This goes beyond the schema, which lists them as separate optional properties.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description specifies the action (upload a PDF), the target platform (PDFGate), and the purpose (to be referenced by other operations). It clearly distinguishes from sibling tools by focusing on the upload step, not PDF processing or retrieval.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context that this is a prerequisite for other operations ("so it can be referenced"), implying it should be used before consumption. It does not explicitly mention alternatives or when not to use it, but the purpose is unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
void_envelopeAInspect
Void (cancel) an envelope in 'created' or 'in_progress' status. Recipients who have not signed are notified by email and their signing links stop working; documents already signed by all recipients are not affected. The optional reason is visible to recipients. Cannot be undone.
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | Reason for voiding. Included in the cancellation email sent to recipients | |
| envelopeId | Yes | The envelope ID to void |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses key behavioral traits: notification to unsigned recipients, invalidation of signing links, non-effect on fully signed documents, visibility of the reason to recipients, and irreversibility. It does not mention auth requirements or side effects on other systems, but covers the core mutation semantics well.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three concise sentences deliver high-value information with no filler. The action and status constraint are front-loaded, followed by recipient impact, the reason visibility, and irreversibility. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a two-parameter, irreversible action tool, the description covers the operation's scope, side effects, and parameter semantics sufficiently. Since no output schema exists, the description does not need to detail return values. The status restriction answers what conditions are valid, and irreversibility warns against misuse.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% for both parameters, so the baseline is 3. The description adds value by explaining that 'reason' is visible to recipients and included in the cancellation email, which goes beyond the schema's bare description. It also makes clear that envelopeId is the target of the void action.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action (void/cancel), a specific resource (envelope), and the applicable statuses ('created' or 'in_progress'). It also distinguishes behavior from other envelope operations by noting the effect on unsigned recipients and that fully signed documents are unaffected.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly says the tool applies to envelopes in 'created' or 'in_progress' status and what happens to recipients, which guides when to use it. It does not explicitly name alternative tools or situations where another tool would be preferred, but the status limitation and irreversible nature give clear contextual guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
watermark_pdfBInspect
Apply a text or image watermark to a PDF. For type='text' provide 'text'; for type='image' provide 'watermarkImagePath'.
| Name | Required | Description | Default |
|---|---|---|---|
| font | No | Standard PDF font name | |
| text | No | Watermark text (required when type='text') | |
| type | Yes | Watermark type | |
| rotate | No | Rotation in degrees (0–360) | |
| opacity | No | Opacity 0–1 | |
| fontSize | No | Font size in points | |
| metadata | No | Custom metadata to attach | |
| fontColor | No | Font colour as hex e.g. '#FF0000' | |
| xPosition | No | Horizontal position | |
| yPosition | No | Vertical position | |
| documentId | Yes | The source document ID | |
| imageWidth | No | Image watermark width | |
| imageHeight | No | Image watermark height | |
| fontFilePath | No | Local path to a .ttf/.otf font file (overrides 'font') | |
| watermarkImagePath | No | Local path to a .png/.jpg watermark image (required when type='image') | |
| preSignedUrlExpiresIn | No | Pre-signed download URL expiry in seconds (60–86400) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behavioral traits. It states the tool applies a watermark but omits critical details such as whether the original PDF is modified or a new copy is created, required permissions, or limitations on file size or supported formats. The lack of transparency increases risk for the agent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, very concise, and front-loaded with the primary action. It avoids unnecessary words and is easy to parse. It could be slightly more structured (e.g., bullet points for conditional parameters) but remains highly efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (16 parameters, no output schema, no annotations), the description is too minimal. It fails to explain the output or side effects, lacks context for deciding between text and image watermarks, and does not address any potential pitfalls. A more complete description is warranted for such a parameter-rich tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, so each parameter already includes semantic meaning. The description adds a small conditional usage note ('For type='text' provide 'text'; for type='image' provide 'watermarkImagePath''), which aligns with the schema. This is adequate but not significantly additive beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Apply a text or image watermark') and the target resource ('a PDF'). It specifies both the text and image variants, effectively distinguishing the tool's purpose from sibling tools that perform different PDF operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description hints at conditional parameter usage based on type but does not provide guidance on when to prefer watermark_pdf over siblings like flatten_pdf or compress_pdf. There is no explicit 'when to use' or 'when not to use' guidance, leaving the agent to infer context from the tool name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
5 tool updates
v1.5.0- Changed
create_envelope2 fields changed- added
Input schema / properties / documents / items / properties / recipients / items / properties / autoSignAdded value: +{ + "description": "Automatic signing. Applies the stored signature of the referenced recipient on their behalf when their turn to sign comes, with no signing session or email. Requires recipientId pointing to a recipient with an active stored signature (request it with the request_recipient_signature tool) and cannot be combined with embedded. Every required field of the recipient must already have a value before the document is sent, except signature and auto-filled date fields", + "type": "boolean" +} - added
Input schema / properties / documents / items / properties / recipients / items / properties / sendSignedCopyAdded value: +{ + "description": "Whether to email this recipient the signed document when the document completes. Defaults to true for recipients who sign through the emailed signing link and false for embedded and automatic signing recipients", + "type": "boolean" +}
- Changed
create_webhook1 field changed- changed
Input schema / properties / eventTypes / items / enumPrevious 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" +]
- Added
delete_recipient - Added
remove_recipient_signature - Added
request_recipient_signature
2 tool updates
v1.4.0- Changed
create_envelope1 field changed- added
Input schema / properties / documents / items / properties / recipients / items / properties / signingOrderAdded 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" +}
- Changed
create_webhook1 field changed- changed
Input schema / properties / eventTypes / items / enumPrevious 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" +]
6 tool updates
v1.3.0- Added
create_embed_link - Changed
create_envelope5 fields changed- changed
Input schema / properties / documents / items / properties / recipients / items / properties / email / descriptionPrevious value: -"Recipient email address"New value: +"Recipient email address. Required when recipientId is not provided" - added
Input schema / properties / documents / items / properties / recipients / items / properties / embeddedAdded value: +{ + "description": "Embedded recipients sign inside your own application through a short-lived embed link and receive no emails from PDFGate", + "type": "boolean" +} - changed
Input schema / properties / documents / items / properties / recipients / items / properties / name / descriptionPrevious value: -"Recipient display name"New value: +"Recipient display name. Required when recipientId is not provided" - added
Input schema / properties / documents / items / properties / recipients / items / properties / recipientIdAdded value: +{ + "description": "ID of a stored recipient to reuse. Provide either recipientId or email and name, never both", + "type": "string" +} - removed
Input schema / properties / documents / items / properties / recipients / items / requiredRemoved value: -[ - "email", - "name" -]
- Added
create_recipient - Added
get_recipient - Added
list_recipients - Added
update_recipient
4 tool updates
v1.2.0- Changed
create_envelope4 fields changed- changed
Input schema / properties / documents / items / properties / recipients / items / properties / reminderAttempts / descriptionPrevious value: -"Maximum number of reminder emails"New value: +"Maximum number of reminder emails (defaults to 5)" - added
Input schema / properties / documents / items / properties / recipients / items / properties / reminderAttempts / maximumAdded value: +10 - added
Input schema / properties / documents / items / properties / recipients / items / properties / reminderAttempts / minimumAdded value: +1 - added
Input schema / properties / expiresInDaysAdded 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" +}
- Changed
create_webhook1 field changed- changed
Input schema / properties / eventTypes / items / enumPrevious 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" +]
- Added
delete_envelope - Added
void_envelope
7 tool updates
v1.1.0- Added
add_form_fields - Added
download_file - Added
extract_form_data - Removed
extract_pdf_form_data - Added
get_webhook - Added
upload_file - Removed
upload_pdf
14 tool updates
v1.0.1- First observed
compress_pdf - First observed
create_envelope - First observed
create_webhook - First observed
delete_document - First observed
delete_webhook - First observed
extract_pdf_form_data - First observed
flatten_pdf - First observed
generate_pdf - First observed
get_document - First observed
get_envelope - First observed
protect_pdf - First observed
send_envelope - First observed
upload_pdf - First observed
watermark_pdf
TDQS
Scored across 27 tools
The surface splits cleanly into four resource families (documents, recipients, envelopes, webhooks), and the descriptions proactively resolve the few confusable pairs (download_file vs get_document, delete_document vs delete_envelope, delete_recipient vs remove_recipient_signature, create_embed_link vs send_envelope). The remaining risk is the four transform tools (protect_pdf, flatten_pdf, compress_pdf, watermark_pdf), which are only distinguishable by reading the names closely, but their purposes are in fact distinct.
Every one of the 27 tools follows a snake_case verb_noun pattern (create_/get_/list_/update_/delete_/remove_/send_/void_ plus a resource), with no camelCase or bare-noun outliers. Domain-specific verbs (protect_pdf, flatten_pdf, watermark_pdf) still conform to the same verb_resource shape.
27 tools is on the heavy side, though the server genuinely spans three loosely coupled domains: PDF manipulation (~10 tools), recipients with automatic signing (7), envelopes (6) and webhooks (3). Each tool does earn roughly its place, but the document-processing group could plausibly have been consolidated into a single parameterized transform tool.
Recipients have full CRUD plus listing and signature lifecycle support, but the other families are missing key discovery/lifecycle operations: there is no list_documents, list_envelopes, or list_webhooks, and no update_envelope or webhook update. An agent can create and fetch by ID but cannot enumerate resources, which is a real dead end for discovery workflows.
Maintenance
Related MCP Connectors
Generate and read PDFs for AI agents: a generate_pdf and a read_pdf tool, priced per document.
PDF tools for AI agents: validate, extract, merge, split, compress, OCR, sign and redact.
Convert, create and edit Word, PowerPoint, Excel and PDF documents from any AI agent.
Convert, merge, compress, OCR, redact, and sign PDFs inside your AI assistant. From pdfAssistant.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables PDF manipulation including text, images, annotations, form fields, page operations, and metadata through natural language.16MIT
- AlicenseCqualityDmaintenanceEnables AI assistants to perform PDF operations like merge, split, compress, convert, encrypt, OCR, and summarize using natural language.988 npmMIT

pdf4me-mcpofficial
AlicenseBqualityDmaintenanceEnables AI assistants to perform a wide range of PDF processing tasks, including conversion, editing, merging, splitting, OCR, barcode/QR code generation and reading, AI-powered data extraction, and image processing, through the PDF4me API.92MIT- AlicenseNot gradedqualityCmaintenanceEnables AI assistants to generate PDFs from templates using dynamic data, manage async PDF jobs, list templates, and check account credits and transaction history through natural language.38 npmMIT