Skip to main content
Glama

JustFill PDF Form Automation

List fields

list_fields
Read-only

List the current working fields and workspace summary for an open PDF workspace.

Returns `{"summary": ..., "fields": [...]}` for `workspace_id`, reflecting any
in-workspace edits made via `add_field`, `update_field`, `update_fields`,
`remove_field`, `remove_fields`, or `prune_fields`. Each field entry includes
`id`, `name`, `type`, `page_index` (0-based), bounding-box percentages
(`x`, `y`, `w`, `h`), `confidence`, `source` (`'template'`, `'acroform'`,
`'ml'`, or `'agent'`), and `needs_name_review`.

Filtering: pass a 0-based `page_index` to return only the fields on that
single page, or omit `page_index` (pass `None`) to list fields across all
pages in the workspace.

When to use:
- Use `list_fields` to inspect current field IDs, coordinates, or labels in an
  already-open workspace (for example, after editing fields or narrowing to one
  page) without re-running detection.
- Use `open_pdf` to load a document for the first time and create a workspace.
- Use `list_templates` to list saved, reusable account-level templates rather
  than the fields of an active workspace.

Input Schema

NameRequiredDescriptionDefault
page_indexNoOptional 0-based page index (`0` to `page_count - 1`) to filter fields to a single page. Omit or pass `None` to list fields across all pages in the workspace.
workspace_idYesActive workspace ID returned by `open_pdf` (`summary.workspace_id`).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / page_index / description
      Added value: +"Optional 0-based page index (`0` to `page_count - 1`) to filter fields to a single page. Omit or pass `None` to list fields across all pages in the workspace."
    • addedInput schema / properties / workspace_id / description
      Added value: +"Active workspace ID returned by `open_pdf` (`summary.workspace_id`)."
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, yet the description still adds real context: it states that results reflect in-workspace edits made by add/update/remove/prune_field(s), and it describes the confidence and needs_name_review attributes. This tells the agent the output is live state, not a static snapshot.

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 return shape, filtering, and usage guidance in a scannable structure. The enumeration of every field-entry key partly duplicates the output schema, making it slightly longer than necessary.

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?

With annotations, a 100%-covered two-parameter schema, and an output schema present, the description covers everything an agent needs: scope, edit reflectivity, page filtering, and sibling routing. No gaps remain 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 meaning beyond the schema by framing page_index as the all-pages-vs-single-page toggle and tying workspace_id to an active, already-opened workspace. It largely reinforces rather than extends the schema text, which keeps it below a 5.

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 and resource ('List the current working fields and workspace summary') plus the scope ('open PDF workspace'). It explicitly distinguishes itself from open_pdf and list_templates, so an agent can pick it without opening any schema.

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 names the exact scenarios (inspecting IDs/coords/labels in an already-open workspace, after edits, or narrowed to one page) and routes the agent to the two siblings for other cases. No inference is required.

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.