Skip to main content
Glama

Linkup extract (closed beta, start task)

linkup-extract

Start an asynchronous extraction task that turns a listing page into row-based data delivered as an NDJSON file, then poll and download the structured results.

Instructions

Start an Extract task (POST /v1/extract) that turns a listing page into rows of data, delivered as an NDJSON file. CLOSED BETA: the API answers 403 unless Linkup has enabled it for the organisation. Variable price, typically 2 to 10 USD per completed task, shown as creditsUsed in the output; failed tasks are free; a balance of at least 10 USD is required. Asynchronous: poll with linkup-get-extract every 30 s, then download with linkup-extract-download. For one JSON object from one known page use linkup-fetch with schema instead.

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

Input Schema

NameRequiredDescriptionDefault
urlYesSeed URL the agent starts from (listing, directory, catalogue page).
queryYesWhat rows to extract and what each row holds, in natural language.
schemaNoOptional JSON Schema (root type object) describing ONE row; applied to every row.
verify_urlsNoCheck that URLs in the rows resolve. Adds latency.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: closed-beta 403 unless the organisation is enabled, variable price of 2-10 USD per completed task surfaced as creditsUsed, failed tasks free, and a 10 USD minimum balance requirement. It also discloses the asynchronous nature and polling cadence, which the annotations (readOnlyHint=false, openWorldHint=true, idempotentHint=false) do not convey.

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

Conciseness5/5

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

Four densely packed sentences, front-loaded with the action and endpoint, then gating/billing facts, then the async workflow, then the alternative tool. Every sentence carries decision-relevant information with no filler.

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?

With no output schema, the description compensates by naming the return shape (NDJSON file, creditsUsed) and the follow-up download tool. The only small gap is that it doesn't say whether task IDs are returned directly or must be discovered via linkup-list-extract.

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 description coverage is 100%, so the baseline is 3; the schema already documents url as a seed listing/directory page, query as natural-language row specification, schema as a per-row JSON Schema, and verify_urls' latency cost. The description adds the phrase 'listing page' but no parameter-level detail the schema lacks.

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 -- 'Start an Extract task (POST /v1/extract) that turns a listing page into rows of data' -- plus the delivery format (NDJSON). It explicitly contrasts with linkup-fetch 'for one JSON object from one known page', so an agent can distinguish it from the sibling 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?

Gives explicit when-to-use (multi-row listing extraction) and when-not-to (single known page -> linkup-fetch with schema), plus the full workflow sequencing: poll with linkup-get-extract every 30 s, then download with linkup-extract-download. Nothing about tool selection is left to inference.

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