Skip to main content
Glama

Several results from one page visit

scrape_url
Idempotent

Exposes POST /scrape. Runs any subset of the other operations in one request, served from a single page visit where possible. Each operation is billed and stored exactly as the individual call would be, so this is not a discount — with one exception, and it is the reason to use it: a residential exit is charged per page VISIT, so several results off one visit pay the surcharge once.

Answers with one object keyed by operation, each entry carrying its own success and result, so a partial failure still returns everything that worked.

lighthouse does not share the visit — it runs its own audit on its own engine — so including it means two page fetches, and two surcharges when residential is on. So does a screenshot whose screenshot_options set viewport_width, viewport_height, device_scale_factor, dark_mode or block_ads: those change how the page loads, so the screenshot gets a visit of its own.

Input Schema

NameRequiredDescriptionDefault
urlYesThe page to fetch. Must be a public http(s) URL.
syncNoWait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
deviceNoLighthouse only, when it is among the operations. Default mobile.
fieldsNoextract only, and required when it is among the operations: the fields to fill, exactly as extract_data takes them.
labelsNoYour own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_ageNoHow fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_toNoAsync only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
operationsYesWhich operations to run off this page.
project_idYesWhich project this request belongs to. From list_projects.
pdf_optionsNoPDF only, when it is among the operations: how to print it, exactly as capture_pdf takes it.
residentialNoFetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic.
auth_profileNoLoad the page signed in, as this auth profile's visitor: its id, ap_…. A profile is a browser's signed-in state uploaded once over the HTTP API (POST /auth_profiles); only URLs on its domains are accepted. Costs nothing extra. https://urlpipe.dev/docs/auth-profiles
instructionsNoOptional guidance that applies to every field, e.g. "prices in EUR".
page_optionsNoWhat to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them.
include_auditsNoLighthouse only: include the full per-audit detail. Default false.
idempotency_keyNoMakes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age "0". Up to 255 printable ASCII characters; a UUID is ideal.
screenshot_optionsNoScreenshot only, when it is among the operations: how to take it, exactly as capture_screenshot takes it.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / auth_profile
      Added value: +{
      +  "description": "Load the page signed in, as this auth profile's visitor: its id, ap_…. A profile is a browser's signed-in state uploaded once over the HTTP API (POST /auth_profiles); only URLs on its domains are accepted. Costs nothing extra. https://urlpipe.dev/docs/auth-profiles",
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • changedInput schema / properties / screenshot_options / properties / styles / description
      Previous value: -"CSS to inject into the page before capturing."New value: +"CSS to inject into the page before capturing, up to 20000 characters."
  3. Changed2 schema fields changed
    • changedInput schema / properties / page_options / description
      Previous value: -"What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too."New value: +"What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    • addedInput schema / properties / page_options / properties / scroll_to_bottom
      Added value: +{
      +  "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled.",
      +  "type": "boolean"
      +}
  4. Changed5 schema fields changed
    • addedInput schema / properties / fields
      Added value: +{
      +  "description": "extract only, and required when it is among the operations: the fields to fill, exactly as extract_data takes them.",
      +  "items": {
      +    "properties": {
      +      "description": {
      +        "description": "What to take from the page. The more specific, the better.",
      +        "type": "string"
      +      },
      +      "fields": {
      +        "description": "For an object: its fields, shaped like this one.",
      +        "items": {
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "items": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "object"
      +          }
      +        ],
      +        "description": "For an array: what it holds — a type such as \"string\", or {\"type\": \"object\", \"fields\": [...]}."
      +      },
      +      "name": {
      +        "description": "The key in the result: letters, digits and underscores.",
      +        "type": "string"
      +      },
      +      "type": {
      +        "enum": [
      +          "string",
      +          "number",
      +          "integer",
      +          "boolean",
      +          "date",
      +          "datetime",
      +          "url",
      +          "email",
      +          "object",
      +          "array"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "name",
      +      "type"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / instructions
      Added value: +{
      +  "description": "Optional guidance that applies to every field, e.g. \"prices in EUR\".",
      +  "type": "string"
      +}
    • changedInput schema / properties / operations / items / enum
      Previous value: -[
      -  "html",
      -  "screenshot",
      -  "markdown",
      -  "meta",
      -  "summarize",
      -  "keywords",
      -  "lighthouse",
      -  "console"
      -]New value: +[
      +  "html",
      +  "screenshot",
      +  "markdown",
      +  "meta",
      +  "summarize",
      +  "keywords",
      +  "lighthouse",
      +  "console",
      +  "technologies",
      +  "pdf",
      +  "extract"
      +]
    • addedInput schema / properties / page_options / properties / block_popups
      Added value: +{
      +  "description": "Remove newsletter, app-install and promotional popups laid over the page.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / pdf_options
      Added value: +{
      +  "description": "PDF only, when it is among the operations: how to print it, exactly as capture_pdf takes it.",
      +  "properties": {
      +    "landscape": {
      +      "description": "Landscape orientation. Default false.",
      +      "type": "boolean"
      +    },
      +    "margin": {
      +      "description": "Margin on every side, 0 to 50 mm. Default 10.",
      +      "type": "integer"
      +    },
      +    "media": {
      +      "description": "print (default) uses the page's print stylesheet; screen prints it as a browser shows it.",
      +      "enum": [
      +        "print",
      +        "screen"
      +      ],
      +      "type": "string"
      +    },
      +    "paper_size": {
      +      "description": "The paper. Default a4.",
      +      "enum": [
      +        "letter",
      +        "legal",
      +        "tabloid",
      +        "a3",
      +        "a4",
      +        "a5"
      +      ],
      +      "type": "string"
      +    },
      +    "print_background": {
      +      "description": "Print background colours and images. Default true.",
      +      "type": "boolean"
      +    },
      +    "scale": {
      +      "description": "Scale of the page, 10 to 200 percent. Default 100.",
      +      "type": "integer"
      +    },
      +    "single_page": {
      +      "description": "One page as wide as the browser window and as tall as the whole document, instead of paper-sized sheets. Default false.",
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  5. Changed1 schema field changed
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "operations": {
      -        "additionalProperties": {
      -          "properties": {
      -            "cached": {
      -              "type": "boolean"
      -            },
      -            "error": {
      -              "type": "string"
      -            },
      -            "result": {},
      -            "success": {
      -              "type": "boolean"
      -            }
      -          },
      -          "type": "object"
      -        },
      -        "description": "One key per operation requested, in the order asked for.",
      -        "type": "object"
      -      },
      -      "url": {
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "labels": {
      -        "type": "object"
      -      },
      -      "status": {
      -        "const": "accepted",
      -        "type": "string"
      -      },
      -      "token": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "token",
      -      "status"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "final_url": {
      +        "description": "The address the page ended on, after its redirects.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "operations": {
      +        "additionalProperties": {
      +          "properties": {
      +            "cached": {
      +              "type": "boolean"
      +            },
      +            "error": {
      +              "type": "string"
      +            },
      +            "result": {},
      +            "success": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "description": "One key per operation requested, in the order asked for.",
      +        "type": "object"
      +      },
      +      "url": {
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "labels": {
      +        "type": "object"
      +      },
      +      "status": {
      +        "const": "accepted",
      +        "type": "string"
      +      },
      +      "token": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "token",
      +      "status"
      +    ],
      +    "type": "object"
      +  }
      +]
  6. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "anyOf": [
      +    {
      +      "properties": {
      +        "operations": {
      +          "additionalProperties": {
      +            "properties": {
      +              "cached": {
      +                "type": "boolean"
      +              },
      +              "error": {
      +                "type": "string"
      +              },
      +              "result": {},
      +              "success": {
      +                "type": "boolean"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "description": "One key per operation requested, in the order asked for.",
      +          "type": "object"
      +        },
      +        "url": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "properties": {
      +        "labels": {
      +          "type": "object"
      +        },
      +        "status": {
      +          "const": "accepted",
      +          "type": "string"
      +        },
      +        "token": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "token",
      +        "status"
      +      ],
      +      "type": "object"
      +    }
      +  ],
      +  "type": "object"
      +}
  7. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnly=false, openWorld=true, idempotent=true and non-destructive. The description adds real behavior beyond that: each operation is billed and stored as if called alone, results come back keyed by operation with per-entry success so partial failures still return everything that worked, and certain option combinations trigger a second page fetch and a second surcharge.

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?

Three tight paragraphs that front-load the core idea and then the economics, followed by the exceptions. The opening 'Exposes POST /scrape' is a redundant implementation detail, and the long dash-laden sentence about screenshot options is denser than it needs to be, but nearly every sentence carries decision-relevant information.

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?

For a 17-parameter tool with nested option objects and an output schema, the description covers what structured fields cannot: why to batch, how billing and caching interact, and what happens on partial failure. Return shape is delegated to the output schema, which is appropriate.

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 individual parameters are already documented; the description's value is cross-parameter semantics the schema cannot express — that residential billing is per visit, and that screenshot_options viewport_width, viewport_height, device_scale_factor, dark_mode and block_ads force a separate visit. It does not touch sync, max_age or idempotency_key, but those are fully described in the schema.

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 action and resource: runs any subset of the other operations in one request against a single page. It explicitly distinguishes itself from the sibling operation tools (lighthouse, capture_screenshot) and explains the batching role that no sibling fills.

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 an explicit reason to choose this over individual calls (residential surcharge is charged per page visit, so bundling pays it once) and explicitly states it is not a discount otherwise. It also names the two cases where batching does not apply — lighthouse and screenshots with viewport/dark_mode/block_ads options — which is exactly the when-not guidance an agent needs.

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