Skip to main content
Glama

Create Public Link

create_link
Destructive

Create a reusable public signing link from a PDF already uploaded with upload_file. The link is live the moment this returns — share the returned linkUrl yourself, Formify sends no invitations to anyone. THIS COSTS CREDITS. On the credits pricing model every live link is a billed instance, charged pro rata for the rest of the current period and renewed each period while it stays active. ALWAYS confirm with the user before calling this. Insufficient credits returns 402 and creates nothing; a suspended subscription returns 403. Requires the publicLinksCreate capability. signeeDetails here describes SIGNATURE SLOTS, not people: there are no recipients, so no email, phone, delivery method or signing order. signatureBox is required for every slot placed on an existing page, because there is no template to inherit coordinates from. BEFORE calling, ask the user: (1) the language signers should see, (2) whether the AI assistant should be enabled — only if get_account_capabilities confirms aiAssistant, (3) confirmation that a billed link may be created.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoName of the link. Shown in Formify, not to signers.
fileIdYesFile ID from upload_file
languageNoLanguage of the signing experience shown to whoever opens the link (default en)
aiAssistantNoOptional AI assistant that helps signees while reviewing the document. Requires the aiAssistant capability.
signeeDetailsYesThe signature slots on the link. At least one is required.
sharingSettingNoWho on the account may administer the link: private (default) or shared (requires the accessLevels capability). This does not affect who may SIGN it — a public link is public by definition.
disablePrintingNoPrevent signers from printing the document.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / signeeDetails / items / properties / idScanBox / description
      Previous value: -"Required when signatureType is 'digital_ink_id_scan', unused otherwise. The ID document itself is captured and read on Formify's signing page; only the placeholder's position is configured here, and no image or document data passes through this API."New value: +"Required when signatureType is 'digital_ink_id_scan', unused otherwise. The ID document itself is captured and read on Formify's signing page; only the placeholder's position is configured here, and no image or document data passes through this API. The scanned front side is then placed in the signed document at this position, so the sender needs a legal basis for keeping a copy of the identity document there (see signatureType)."
    • changedInput schema / properties / signeeDetails / items / properties / signatureType / description
      Previous value: -"Signature method for this slot. Same values and capability requirements as on a document: digital_ink (default), bankid_identification (signatureBankId), digital_ink_id_scan (signatureIdScan), face_liveness (signatureFaceLiveness). Call get_account_capabilities before using a non-default type. Identity verification for bankid_identification, digital_ink_id_scan and face_liveness is performed by Formify's signing page in the signer's browser, after the invitation is sent. This parameter only selects the method: no identity document, biometric data or national identity number is sent to, returned by or stored through this API."New value: +"Signature method for this slot. Same values and capability requirements as on a document: digital_ink (default), bankid_identification (signatureBankId), digital_ink_id_scan (signatureIdScan), face_liveness (signatureFaceLiveness). Call get_account_capabilities before using a non-default type. Identity verification for bankid_identification, digital_ink_id_scan and face_liveness is performed by Formify's signing page in the signer's browser, after the invitation is sent. This parameter only selects the method: no identity document, biometric data or national identity number is sent to, returned by or stored through this API. digital_ink_id_scan additionally places an image of the signer's identity document (front side) in the signed document, at the idScanBox position. Reproducing a copy of an identity document requires the sender's own legal basis: before selecting this method, tell the user that a copy of the ID document will be embedded in the signed document and get an explicit yes. Suggest another signing method if they do not need a copy of the identity document in the document."
  2. Changed4 schema fields changed
    • changedInput schema / properties / signeeDetails / items / properties / hidePersonalNumber / description
      Previous value: -"Leave the signer's personal number out of the rendered signature. Only meaningful for signature types that collect one."New value: +"Leave the signer's national identity number off the rendered signature. Only meaningful for bankid_identification: the signer's BankID identification supplies that number to Formify's signing page, which prints it beside the signature by default. The number is handled by the signing page alone — it is never sent to, returned by or stored through this API."
    • changedInput schema / properties / signeeDetails / items / properties / idScanBox / description
      Previous value: -"Required when signatureType is 'digital_ink_id_scan', unused otherwise."New value: +"Required when signatureType is 'digital_ink_id_scan', unused otherwise. The ID document itself is captured and read on Formify's signing page; only the placeholder's position is configured here, and no image or document data passes through this API."
    • changedInput schema / properties / signeeDetails / items / properties / paymentLink / description
      Previous value: -"Collect a payment before this slot can be signed. Payment links are set up in the Formify client, not through this API — do not invent an id. The link must allow multiple use, since one public link is signed by many people. Requires the signAndPay capability."New value: +"Require a payment before this slot can be signed, by referencing a payment link that already exists on the account. Payment links are set up in the Formify client, not through this API — do not invent an id. The payment itself is taken on Formify's signing page: no card or payment data is collected, transmitted or stored by this API. The link must allow multiple use, since one public link is signed by many people. Requires the signAndPay capability."
    • changedInput schema / properties / signeeDetails / items / properties / signatureType / description
      Previous value: -"Signature method for this slot. Same values and capability requirements as on a document: digital_ink (default), bankid_identification (signatureBankId), digital_ink_id_scan (signatureIdScan), face_liveness (signatureFaceLiveness). Call get_account_capabilities before using a non-default type."New value: +"Signature method for this slot. Same values and capability requirements as on a document: digital_ink (default), bankid_identification (signatureBankId), digital_ink_id_scan (signatureIdScan), face_liveness (signatureFaceLiveness). Call get_account_capabilities before using a non-default type. Identity verification for bankid_identification, digital_ink_id_scan and face_liveness is performed by Formify's signing page in the signer's browser, after the invitation is sent. This parameter only selects the method: no identity document, biometric data or national identity number is sent to, returned by or stored through this API."
  3. Added

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing the credit-billing model (pro rata charge each period, renewed while active), the 402 and 403 failure semantics, and that failure creates nothing. It also surfaces capability gates and the important 'slots not people' reinterpretation of signeeDetails. No contradiction with destructiveHint=true or readOnlyHint=false.

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

Conciseness4/5

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

Front-loads the core action and outcome, then layers cost, errors and preconditions in a logical order. It is dense and long, but nearly every sentence carries actionable content rather than restating the schema; only mild redundancy around crediting/billing keeps it from a 5.

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

Completeness5/5

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

For a complex, nested, mutation tool with no output schema, the description covers preconditions, capability requirements, error behavior, billing consequences and the non-obvious semantics of the required nested parameter. An agent has everything needed to invoke it correctly and responsibly.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds genuine interpretive value the schema lacks: signeeDetails represents SIGNATURE SLOTS (no recipients, email, phone, delivery method or signing order) and that signatureBox is mandatory on existing pages because a public link inherits no coordinates. It stops short of explaining several other parameters, so not a full 5.

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

Purpose5/5

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

States a specific verb and resource ('Create a reusable public signing link') and names the source dependency ('from a PDF already uploaded with upload_file'). This distinguishes it from sibling creation tools like create_document and create_draft without needing their schemas.

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

Usage Guidelines5/5

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

Explicitly says to ALWAYS confirm with the user before calling, and enumerates three pre-call questions (language, AI assistant enablement gated on capability, billing confirmation). It also clarifies the link is public and self-shared ('Formify sends no invitations'), and notes the required publicLinksCreate capability.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources