Skip to main content
Glama

JustFill PDF Form Automation

Update a field

update_field
Destructive

Modify an existing field's position, size, semantic name, type, or alignment in the active workspace.

Overwrite/merge behavior: performs a partial update (patch) on `field_id` in
`workspace_id`. Only the optional parameters explicitly provided with non-`None`
values (`x`, `y`, `w`, `h`, `name`, `field_type`, `align`, `vertical_align`)
overwrite the field's attributes; omitted or `None` parameters keep their
existing values unchanged. Editing an ML-detected field (`source="ml"`)
promotes it to `source="agent"` with `confidence=1.0`. Returns the updated
field dict, or `{"error": ...}` if `field_id` is not found in the workspace.

Persistence & review impact: changes persist immediately in the active
workspace (`workspace_id`), invalidate the page's visual review receipt when
geometry (`x`, `y`, `w`, `h`) changes, and do not affect saved account
templates unless `save_template` is called.

When to use:
- Use `update_field` when modifying a single existing field.
- Use `update_fields` for batch updates across 2 or more fields in one call
  (e.g. assigning semantic `name`s before `save_template`).
- Use `add_field` to create a missing field, or `remove_field` to delete a
  false-positive field.

Input Schema

NameRequiredDescriptionDefault
hNoNew box height as a percentage of page height (`> 0.0` and `<= 100.0 - y`). Omit or pass `None` to keep the existing `h`.
wNoNew box width as a percentage of page width (`> 0.0` and `<= 100.0 - x`). Omit or pass `None` to keep the existing `w`.
xNoNew left-edge horizontal coordinate as a percentage of page width (`0.0`–`100.0`, top-left origin). Omit or pass `None` to keep the existing `x`.
yNoNew top-edge vertical coordinate as a percentage of page height (`0.0`–`100.0`, top-left origin). Omit or pass `None` to keep the existing `y`.
nameNoNew short semantic label for the field (e.g. `'company_name'`, `'total_score'`). Omit or pass `None` to keep the existing `name`.
alignNoNew horizontal text alignment: `'left'`, `'center'`, or `'right'`. Omit or pass `None` to keep the existing alignment.
field_idYesID of the existing field to modify (from `open_pdf`, `list_fields`, or `add_field`, e.g. `'p0_f1'` or `'p0_a1'`).
field_typeNoNew field type: `'text'`, `'number'`, `'date'`, `'checkbox'`, `'radio'`, `'signature'`, `'dropdown'`, `'field'`, or `'cell'`. Omit or pass `None` to keep the existing type.
workspace_idYesActive workspace ID returned by `open_pdf` (`summary.workspace_id`).
vertical_alignNoNew vertical text alignment: `'top'`, `'middle'`, or `'bottom'`. Omit or pass `None` to keep the existing vertical alignment.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • addedInput schema / properties / align / description
      Added value: +"New horizontal text alignment: `'left'`, `'center'`, or `'right'`. Omit or pass `None` to keep the existing alignment."
    • addedInput schema / properties / field_id / description
      Added value: +"ID of the existing field to modify (from `open_pdf`, `list_fields`, or `add_field`, e.g. `'p0_f1'` or `'p0_a1'`)."
    • addedInput schema / properties / field_type / description
      Added value: +"New field type: `'text'`, `'number'`, `'date'`, `'checkbox'`, `'radio'`, `'signature'`, `'dropdown'`, `'field'`, or `'cell'`. Omit or pass `None` to keep the existing type."
    • addedInput schema / properties / h / description
      Added value: +"New box height as a percentage of page height (`> 0.0` and `<= 100.0 - y`). Omit or pass `None` to keep the existing `h`."
    • addedInput schema / properties / name / description
      Added value: +"New short semantic label for the field (e.g. `'company_name'`, `'total_score'`). Omit or pass `None` to keep the existing `name`."
    • addedInput schema / properties / vertical_align / description
      Added value: +"New vertical text alignment: `'top'`, `'middle'`, or `'bottom'`. Omit or pass `None` to keep the existing vertical alignment."
    • addedInput schema / properties / w / description
      Added value: +"New box width as a percentage of page width (`> 0.0` and `<= 100.0 - x`). Omit or pass `None` to keep the existing `w`."
    • addedInput schema / properties / workspace_id / description
      Added value: +"Active workspace ID returned by `open_pdf` (`summary.workspace_id`)."
    • addedInput schema / properties / x / description
      Added value: +"New left-edge horizontal coordinate as a percentage of page width (`0.0`–`100.0`, top-left origin). Omit or pass `None` to keep the existing `x`."
    • addedInput schema / properties / y / description
      Added value: +"New top-edge vertical coordinate as a percentage of page height (`0.0`–`100.0`, top-left origin). Omit or pass `None` to keep the existing `y`."
  2. First observed

TDQS

A4.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and openWorldHint=false, so the safety profile is covered structurally, and the description adds real context: patch semantics for non-None params, ML-to-agent source promotion with confidence=1.0, immediate persistence, review-receipt invalidation on geometry changes, and template isolation unless save_template is called. It also discloses the error return shape for a missing field_id. However the destructiveHint=true annotation is never reconciled in prose -- the description presents this as a routine patch without warning that a field's geometry or type can be irreversibly altered, which is the one behavior an agent most needs spelled out for a destructive operation.

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 action, then organized under labeled blocks (Overwrite/merge, Persistence & review impact, When to use) that let an agent scan to the relevant concern. It runs long for a single-field update, and the parameter list is enumerated twice (in the header sentence and again in the patch paragraph), which is mild redundancy.

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?

An output schema exists, so return values needn't be described, yet the description still notes the updated-field dict and the error variant. With ten parameters, a destructive mutation, and cross-cutting effects on review receipts and templates, every consequence an agent needs before calling is present.

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% and each parameter already documents its range and None semantics, so the baseline is 3. The description earns above baseline by stating the unifying rule that ties all eight optional params together -- only non-None values overwrite, everything else is preserved -- which is a cross-parameter contract the per-field schema text cannot express, plus the conditional side effect on source/confidence tied to field_type edits.

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 plus the full attribute set that can be modified ('position, size, semantic name, type, or alignment'), and scopes it to 'the active workspace'. It is immediately distinguishable from add_field, remove_field, and update_fields, all of which are named with their own trigger conditions.

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?

A dedicated 'When to use' block states the single-field case explicitly and routes three alternatives: update_fields for 2+ fields in one call, add_field for missing fields, remove_field for false positives. Both the inclusion condition and the exclusion conditions are given, 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.