Skip to main content
Glama

Update document

update-document
Destructive

Updates a document's name, locale, document type, signing settings and/or external signatory invitation message.

Use this tool when:

  • A document should be renamed

  • The document's content language (locale) or document type should change

  • The signature type or sequential signing setting should change before signing starts

  • The message included in the email inviting external signatories should be set or changed

All arguments except document_uuid are optional and only need to be sent if their value should change. signature_type and sequential_signing cannot be changed once signing has started, and signature_type cannot be changed if it was specified by the document's template. Use the list-account-document-types tool to discover valid document type UUIDs. This tool cannot change the document's stage (use the move-document-to-*-stage tools for that).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew name for the document
localeNoNew locale code for the document content, e.g. en-GB, de-AT
document_uuidYesUUID of the document to update. If you don't already have the document's UUID, use the list-documents tool to find it.
signature_typeNoeIDAS assurance level to use when signing the document. aes_eid is only accepted when the account has enabled AES (eID). Cannot be changed once signing has started or if the value was specified by the template
document_type_uuidNoUUID of the document type to assign. Pass null to remove the current document type. Use the list-account-document-types tool to find valid UUIDs
sequential_signingNoWhen true, signatories will sign one at a time, in ascending order of their signing_order. Cannot be changed once signing has started
external_signatory_invitation_messageNoText to display in the email notification sent to external signatories when the document is ready for signing

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoURL to open the document in fynk
nameNoName of the document
uuidNoUnique identifier for the document. Do not show to the user unless they ask for it
stageNoWhat stage the document is in currently
localeNoLocale code, e.g. en-GB, de-AT. Absent when the document has none set. Prefer describing the locale in natural language (e.g. 'British English') rather than showing the raw code.
originNoHow the document was created.
_entity_typeNoOnly relevant for tooling. Do not show to the user
document_typeNoIf present, indicates what kind of document this is. Absent when the document has no type assigned
signature_typeNoeIDAS assurance level used when signing the document. Absent when none has been chosen.
sequential_signingNoWhen true, signatories sign one at a time, in ascending order of their signing_order.
source_template_uuidNoUUID of the template the document was created from. Absent when it was not created from a template.
external_signatory_invitation_messageNoText shown in the email inviting external signatories to sign. Absent when no message is set.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations declare destructiveHint=true, and the description adds real behavioral context beyond them: conditional mutation limits, template-derived immutability, and that all non-UUID args are optional. It doesn't explain what makes the operation 'destructive' (e.g. passing null to remove the document type), which is the one gap.

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 summary sentence followed by scannable bullets and a constraints paragraph; well organized. Slightly verbose, but nearly every sentence carries distinct operational information.

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?

Output schema exists, so return values need not be described. For a 7-param mutation tool the description covers scope, optionality, constraints, and the relevant sibling alternatives, leaving no critical gap for correct invocation.

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 meaningful semantics: every argument except document_uuid is optional and only sent when changing a value, plus constraints on signature_type/sequential_signing and the discovery tool for document_type_uuid.

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 (Updates) and resource (a document) and enumerates exactly which fields can change: name, locale, document type, signing settings, external invitation message. It explicitly routes stage changes to the `move-document-to-*-stage` tools, distinguishing it from siblings.

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?

Provides explicit when-to-use bullets and names the alternative tool for stage changes. It also states the preconditions (signature_type and sequential_signing cannot change once signing started, signature_type cannot change if set by template), leaving nothing to inference.

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