Formify — AI Assisted E-Signing

Update Public Link

update_link

DestructiveIdempotent

Replace a public link's configuration. THIS IS A FULL REPLACE — anything you leave out is lost. ALWAYS call get_link first and send back the complete configuration with your changes applied; every property round-trips, so nothing is lost by doing it that way. fileId is the one exception: omit it to keep the link's current document. The public URL survives an edit, so anyone already holding the link keeps a working one, and editing is NOT billed again. A disabled link cannot be edited and returns 409 — duplicate it instead. Owner only: a colleague can read and disable a shared link but not edit it.

Input Schema

TableJSON Schema

Name	Required	Description
`name`	No	Name of the link. This is a full replace — send the current name back from get_link unless you are changing it.
`fileId`	No	File ID from upload_file. Omit to keep the link's current document.
`linkId`	Yes	Unique identifier of the public link
`language`	No	Language of the signing experience
`aiAssistant`	No	Optional AI assistant that helps signees while reviewing the document. Requires the aiAssistant capability.
`signeeDetails`	Yes	Replaces the link's signature slots entirely. Take these from get_link and modify them rather than composing a new list.
`sharingSetting`	No	Who on the account may administer the link.
`disablePrinting`	No	Prevent signers from printing the document.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 8, 2026

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."

Changed4 schema fields changedSep 22, 2026

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."

AddedSep 16, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already flag destructive=true and idempotent=true, and the description adds real context beyond that: the omit-and-lose behavior, the fact that the public URL survives an edit, that no re-billing occurs, the 409 on disabled links, and the owner-only authorization requirement. This is the kind of behavioral detail annotations cannot convey.

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 single most dangerous behavior (full replace) before any other detail, and every sentence carries distinct information. The heavy capitalization is slightly noisy, but nothing is wasted and the ordering is deliberately risk-first.

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 destructive, no-output-schema mutation with nested objects and 8 parameters, the description covers the replace contract, the read-before-write prerequisite, the one exception, error behavior, billing effect, and authorization. Nothing an agent needs to invoke it correctly is missing.

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 description coverage is 100%, so the schema carries the field-level burden. The description still adds non-obvious semantics the schema does not state in one place: the complete-config round-trip strategy for every property, and the fileId omission rule ('omit it to keep the link's current document').

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?

Opens with a specific verb+resource ('Replace a public link's configuration') and immediately differentiates itself from siblings by emphasizing FULL REPLACE semantics, which distinguishes it from create_link, duplicate_link and disable_link. An agent knows exactly what this does before opening the schema.

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

Usage Guidelines5/5

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

Explicitly instructs to call get_link first and round-trip the full configuration, names the fileId exception, and routes around the disabled-link case ('A disabled link cannot be edited and returns 409 — duplicate it instead'). It also states the owner-only precondition. When-to-use, when-not-to-use and the alternative are all present.

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

All Formify — AI Assisted E-Signing tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?