signwell_document
SignWell documents sent for signature — create, follow, fetch the signed PDF.
SENDING a draft and reminding signers is signwell_act, another tool.
There is NO "list documents" endpoint: keep the id returned by
op="create". Reads return a compact view — per recipient ONE
signing_link and an explicit emailed, plus notes on what the
status hides; full=True returns SignWell's raw payload.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "signwell_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| op | No | which action. · "get" — status and recipients of `document_id`. · "create" — `files` + `recipients`. ⚠️ Creates a DRAFT unless `draft=False` (SignWell's own default sends immediately). Place fields with `fields` or `text_tags=True` (tags written in the file, syntax: `oto_guide op=read slug="signwell-envoi"`). · "update_recipients" — [{id, name, email}] on a sent document. · "update_authentication" — [{id, passcode?, passcode_delivery?}]. · "completed_pdf" — link to the signed PDF (`audit_page`, `file_format`). The link is a bearer URL. · "nom151_certificate" — link to the Mexican NOM-151 certificate. · "delete" — delete `document_id`; cancels signing in progress. | get |
| _org | No | Org (id) de CET APPEL. `oto_list_orgs()`. | |
| full | No | return SignWell's raw payload. | |
| name | No | ||
| draft | No | op="create" only; default True here. | |
| files | No | [{name, file_url | file_base64}]. `file_url` must be publicly fetchable — a project file's signed `download_url` (`oto_project_files op="list"`) works, and is itself a bearer URL. | |
| _group | No | Équipe (id) de CET APPEL, sous son org parente. | |
| fields | No | ||
| _run_id | No | OBLIGATOIRE à chaque appel dès `run_start` ou `data_claim_next` : sans lui, l'écriture sur une ligne réservée est refusée. Hérité seulement si le serveur tient un run actif — n'y compte pas. | |
| dry_run | No | validate and preview without writing or sending. | |
| message | No | ||
| options | No | rarer spec settings (copied_contacts, labels, metadata, redirect_url, allow_decline, language, custom_requester_name…); an unknown key is refused. | |
| subject | No | ||
| _project | No | Projet (id) de CET APPEL — jeton PRIMAIRE. `oto_project(op='list')`. | |
| _instance | No | Instance de connecteur PRÉCISE (un credential exact). `oto_instance(op='list')`. | |
| reminders | No | ||
| test_mode | No | non-binding document; invitations go to the ACCOUNT OWNER, never to the recipients. | |
| text_tags | No | ||
| audit_page | No | ||
| expires_in | No | ||
| recipients | No | [{id, name, email, …}] — `id` is yours ("1", "2"…) and is the signer number of fields and text tags. Embedded signing only emails a recipient with `send_email: true`. | |
| document_id | No | ||
| file_format | No | ||
| embedded_signing | No | return signing links instead of relying on SignWell's email; anyone holding a link can sign. | |
| apply_signing_order | No |