Skip to main content
Glama

Update Template

update_template
DestructiveIdempotent

Replace a template's configuration. THIS IS A FULL REPLACE — anything you leave out is lost, so call get_template first and send back the complete configuration with your changes applied. fileId is the one exception: omit it to keep the template's current document. Documents already created from the template are unaffected; they took a copy when they were created. Owner only — a colleague can use a shared template but not edit it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoName of the template. This is a full replace — send the current name back from get_template unless you are changing it.
fileIdNoFile ID from upload_file. Omit to keep the template's current document.
templateIdYesUnique identifier of the template
signeeDetailsYesReplaces the template's signature fields entirely.
sharingSettingNoprivate or shared; shared requires the accessLevels capability.
enableSigningOrderNoStore a sequential signing order on the template.

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'."New value: +"Required when signatureType is 'digital_ink_id_scan'. 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 / signatureType / description
      Previous value: -"Signature method to store on the field. Defaults to digital_ink. Non-default methods require account capabilities."New value: +"Signature method to store on the field. Defaults to digital_ink. Non-default methods require account capabilities. 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."
  2. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and readOnlyHint=false, and the description expands on exactly what is destructive: omitting fields loses them, except fileId. It also adds important behavioral context by stating that existing documents are unaffected because they took a copy at creation. This goes well beyond the annotation metadata.

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

Conciseness5/5

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

Four sentences with no filler. The irreversible full-replace warning is front-loaded, followed by the essential exception, legacy impact, and permission constraint. Every sentence earns its place and directly affects whether the agent calls the tool safely.

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 update tool with a rich input schema and no output schema, the description covers the required pre-read step, the preservation exception, post-effect on existing documents, and authorization. An agent has everything it needs to decide to call the tool and construct a correct request.

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 baseline is 3. The description adds a cross-cutting semantic layer — the entire configuration is replaced, not merged — which applies to every parameter and is especially critical for agents composing requests. The fileId exception is also stated globally, which reinforces and extends individual property descriptions.

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 opens with a specific verb and resource: 'Replace a template's configuration.' It then clarifies the defining behavior — a full replace — which immediately distinguishes it from create, get, delete, and duplicate sibling tools. The name and title are reinforced, not merely restated.

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

Usage Guidelines4/5

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

It gives a clear precondition: call get_template first and send back the complete configuration. It also sets an owner-only permission boundary, explaining that colleagues can use but not edit shared templates. It stops short of explicitly naming alternatives like create_template when a new template is needed, so it is not a full 5.

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