Skip to main content
Glama

extract_fields

Extract structured values from local documents into a JSON Schema with page citations, including long lists or tables via array mode.

Instructions

Extract structured values from a local document into a JSON Schema, with citations.

schema: a JSON Schema object (type "object" with properties). instructions: optional guidance for the
extraction. array_extract: true for long lists or tables that span many pages.

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": {
      "path": "<path>",
      "schema": "<schema>"
    },
    "name": "extract_fields"
  }
}

Input Schema

NameRequiredDescriptionDefault
modeNoengine
pathYes
schemaYes
instructionsNo
array_extractNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses that extraction produces citations and is schema-driven, and it explains array_extract behavior, but it does not state whether the operation is read-only, what happens on schema mismatch, or any limits on local document access.

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 description is short and front-loaded, with the core action stated first and parameter notes following. It is efficient, though the trailing whitespace and line break add no value.

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

Completeness3/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 need not be explained. However, for a five-parameter tool with a nested schema object and no annotations, the description is only partially complete because it does not cover mode or path and gives no operational constraints.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate for all five parameters. It explains schema, instructions, and array_extract meaningfully, but it leaves mode completely undocumented and does not explain path, so a significant gap remains.

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 description states a specific verb and resource: extract structured values from a local document into a JSON Schema with citations. This is clear, but it does not differentiate itself from the sibling parse_document, so an agent cannot tell from the description alone which one to choose.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance, no when-not-to-use guidance, and no mention of the sibling parse_document as an alternative. The only usage-like guidance is the parameter hint that array_extract should be true for long lists or tables spanning many pages.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools