Skip to main content
Glama

Get Recipient Links

get_recipient_links
Idempotent

Get unique, self-distributable signing links for a document — one per recipient — so the sender can hand out the links over any channel instead of relying on Formify's email/SMS/WhatsApp invitation. Use this for signees created with disableInvitationMessage: true (Formify did not invite them), or whenever the user wants to distribute a signing link themselves. SECURITY: every returned link is verification-locked. Opening one requires a one-time code that Formify sends to the recipient's contact method on file (the email/phone provided), never to a value the opener types in — so a leaked or forwarded link cannot be opened by anyone else. The lock is enforced automatically in the browser when the recipient opens the link; no extra calls are needed. Simply deliver the signingUrl. The response contains one entry per recipient signing share: signeeId, fullName, emailAddress/phoneNumber (contact on file), verificationChannel ('email' | 'sms' | 'whatsapp'), signingUrl, and requiresVerification (always true). A recipient given BOTH an email and a phone is returned as TWO entries (same signeeId, one per verificationChannel) — present both and let the user choose which to distribute. A recipient with no contact method on file cannot be verified, so they are omitted from the response entirely; add a contact method via update_signee first if a link is expected but missing. Calling this generates and persists the links on first use (idempotent on later calls). Only works on a sent document, not a draft.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYesUnique identifier of the document

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Discloses important behaviors beyond the minimal annotations: first-use generation and persistence with idempotency, security (verification-locked links, one-time code sent to contact on file), automatic browser verification with no extra calls, omission of unverifiable recipients, and duplication for dual-channel recipients. All of this aligns with readOnlyHint=false, destructiveHint=false, idempotentHint=true.

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-loaded with the core purpose, then security, output shape, and caveats. It is long, but every sentence carries unique information and the output format detail justifies the length. Slightly dense with security detail, but not padded.

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?

Covers the full contract: what links are, when to use, how verification works, exact response fields and cardinality (two entries for dual-channel recipients), omitted recipients, idempotency, and the sent-not-draft constraint. No output schema exists, so this description fully compensates.

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?

The schema gives documentId only a generic description ('Unique identifier of the document'), and coverage is 100%. The description adds meaningful constraint: it must identify a sent document, not a draft. It could further clarify what happens with non-existent document IDs or error behavior, but for one param the added semantics are useful.

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

Purpose5/5

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

The description clearly states the verb ('Get'), the resource ('unique, self-distributable signing links for a document'), and the exact purpose. It distinguishes itself from the alternative of relying on Formify's email/SMS/WhatsApp invitations, making its identity unambiguous.

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 states when to use it: for signees created with disableInvitationMessage: true or whenever the user wants to distribute links manually. It also states exclusions: only works on a sent document, not a draft, and directs the user to update_signee when a contact method is missing.

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