Skip to main content
Glama

Extract fields

extract

Return fields from one public page. Call extractors.list for hosts, paths, and the sample schema. You can ask for title, heading, or both. If the page has no extractor, the error points to extractors.list. Call keys.create once. Pass caller_key on every later tools/call.

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": {
      "url": "<url>",
      "json_schema": "<json_schema>"
    },
    "name": "extract"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYes
max_age_sNo
caller_keyNopf_ key from keys.create. Pass this on tools/call when Authorization and X-Caller-Key are not set. A header key wins if both are set.
json_schemaYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / caller_key
      Added value: +{
      +  "description": "pf_ key from keys.create. Pass this on tools/call when Authorization and X-Caller-Key are not set. A header key wins if both are set.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Adds real context beyond the annotations: the auth handshake (keys.create once, caller_key on later calls) and the error behavior when a host/path has no extractor. It does not explain why readOnlyHint=false for what looks like a read (e.g., metering or caching side effects), which leaves a notable gap for an agent judging side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Short and front-loaded with the core action, and every line is operational rather than filler. However, the telegraphic style makes the "title, heading, or both" sentence hard to parse, and the keys.create instruction reads as a disconnected fragment rather than flowing guidance.

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?

Covers the auth and error paths well for a schema-driven extraction tool with no output schema. It is incomplete for a tool whose required json_schema parameter defines the entire response shape, and it says nothing about caching behavior implied by max_age_s.

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 coverage is only 25%, so the description must carry the load, and it largely doesn't. max_age_s (a 1-86400 cache TTL) is never mentioned, and the required json_schema object is only obliquely gestured at with "you can ask for title, heading, or both," which is ambiguous about whether that is the schema's content or a fixed option set.

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?

States a specific verb and resource: "Return fields from one public page," with the singular-page scope front-loaded. It implicitly separates from extract_batch by emphasizing one page, but never names the batch sibling or explains the distinction explicitly.

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?

Gives concrete prerequisite routing: call extractors.list first for hosts, paths, and the sample schema, and call keys.create once before passing caller_key. It also describes the failure path (no extractor -> error points to extractors.list). It stops short of contrasting with extract_batch or explain_extractor.

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