Skip to main content
Glama

Update template dynamic field

update-template-dynamic-field
Destructive

Update an existing dynamic field on a template.

Use this tool when:

  • The user wants to change a dynamic field's name, scope, options, default value, or other properties

Only send the fields you want to change. A field's type cannot be changed after creation; to change the type, delete the field and create a new one.

select and multi_select fields still require non-empty select_values.

The default value is set via value (for non-multi_select fields) or values (for multi_select fields), formatted according to the field's type (see create-template-dynamic-field for the per-type format). Setting a default value clears any autofill configured on the field. Use get-template-info with include=["dynamic_fields"] to discover the dynamic fields on a template and their UUIDs and types.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoDisplay name of the field (max 255 characters)
scopeNoWho fills in the field: "internal" (only your team) or "internal_and_external" (also counterparties)
valueNoDefault value for non-multi_select fields. Format depends on type (see create-template-dynamic-field). Clears any autofill on the field.
valuesNoDefault value for multi_select fields: an array of options from select_values
questionNoOptional question or prompt shown to the user filling in this field
is_mandatoryNoWhether the field must be filled in before the document can be signed
select_valuesNoFor "select" and "multi_select" types: the allowed options for the field
template_uuidYesUUID of the template the dynamic field belongs to
dynamic_field_uuidYesUUID of the dynamic field to update (use get-template-info with include=["dynamic_fields"] to find it)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe name of the field
typeNoControls the type of values that can be stored
uuidNoDo not show to the user unless they ask for it
scopeNoWho fills in the field: "internal" (only your team) or "internal_and_external" (also counterparties)
valueNoFor none-multi_select-type fields, the value of the field. Absent when the field has no value.
valuesNoFor multi_select-type fields, the value of the field. Absent when the field has no value.
questionNoThe question or prompt shown to the user for this field
ref_uuidNoA static reference identifier, allowing dynamic fields in documents to be matched their corresponding field in the document's source template. Do not show to the user unless they ask for it
currenciesNoFor currency or currency_duration fields, the allowed currency codes (e.g. ["EUR", "USD"]). Absent indicates no restriction
_entity_typeNoOnly relevant for tooling. Do not show to the user
is_mandatoryNoWhether this field must be filled in before the document can be signed
select_valuesNoWhen type is "select" or "multi_select", defines the allowed values for the field. For these types of field, ONLY these values are possible. Absent for every other type

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 already mark this as a non-read-only, destructive mutation, but the description adds real behavioral context beyond them: type immutability after creation, the requirement that select/multi_select keep non-empty select_values, and the non-obvious side effect that setting a default value clears any autofill on the field. It does not warn about what happens to documents that already consume changed select_values, which is the main remaining gap for a destructive update.

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?

The purpose is front-loaded in the first line and the constraints are grouped into a short list plus one focused paragraph. Every sentence earns its place, though the single-item bullet block and a stray double line break make the layout slightly heavier than the content requires.

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 9-parameter update tool with a published output schema, this covers the load-bearing items: how to discover valid UUIDs (get-template-info with include=["dynamic_fields"]), what can and cannot be modified, partial-update semantics, and value formatting delegation. Return-value explanation is correctly omitted because the output schema handles it.

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 and the schema already carries most field-level meaning. The description still adds value above that baseline: the distinction that value vs values is driven by multi_select-ness (with format delegated to create-template-dynamic-field), the non-empty select_values constraint for select types, and the autofill-clearing behavior of a default value.

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+resource: 'Update an existing dynamic field on a template.' The verb choice cleanly separates it from the create-template-dynamic-field and delete-template-dynamic-field siblings without needing to name them, and a second sentence enumerates exactly which properties can be changed.

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?

It gives an explicit trigger ('The user wants to change a dynamic field's name, scope, options, default value, or other properties') and an explicit when-not with an alternative path: a field's type cannot be changed, so the agent must 'delete the field and create a new one.' Partial-update semantics ('Only send the fields you want to change') are also stated, which is the key invocation guidance for this tool.

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