Skip to main content
Glama

Get File Fields

get_file_fields
Read-onlyIdempotent

Retrieve all form fields in an uploaded PDF file before creating a document from it. Call this after upload_file to discover fields that can be pre-filled. Value format rule: ONLY textField and radioButton take a plain string. ALL other types (checkbox, combobox, listbox) MUST be an array — even for a single value like ["Beginner"]. Field names containing tink-scan-id (a scan trigger) or tink-scanned-id- (an image of part of the document) place an image of the signer's identity document in the signed document; a trigger combined with a tink-scanned-id-mrz- attribute on the same field only fills in text. Treat such fields like digital_ink_id_scan: tell the user that a copy of the ID document will be embedded in the signed document and get an explicit yes before the document is sent.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "fileId": "<fileId>"
    },
    "name": "get_file_fields"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileIdYesUnique identifier of the uploaded file (from upload_file)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive behavior, so the description appropriately spends its space elsewhere: it discloses a consent obligation (explicit yes required before embedding an ID document) and precise value-format rules for interpreting returned fields. These are non-obvious traits an agent would otherwise get wrong. It does not describe the shape of the return payload, but with no output schema that is a moderate rather than fatal omission.

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?

Purpose and prerequisite are front-loaded in two short sentences before the detailed rules. The tink-scan-id / tink-scanned-id-mrz interaction is dense but load-bearing and cannot be trimmed without losing meaning.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter read tool with no output schema, the description supplies the two things that would otherwise be guesswork: when to call it and how to interpret/serialize the returned field values. Missing only return-shape details (what a field object contains, ordering, empty result behavior).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and fileId is fully documented there; the description adds nothing about the parameter. The format rules concern field values the caller will later submit, not this tool's argument, so they do not raise the parameter score above baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence gives a specific verb and resource ("Retrieve all form fields in an uploaded PDF file") and scopes it to the pre-document stage, which implicitly separates it from get_document_fields/get_template_fields/get_link_fields. It stops short of naming those siblings, so an agent must infer the distinction.

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?

"Call this after upload_file to discover fields that can be pre-filled" gives clear sequencing and intent. No exclusion guidance is offered (e.g., use get_document_fields for already-created documents), so the agent must infer alternatives from the sibling list.

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