Skip to main content
Glama

Get page regions

get_page_regions
Read-onlyIdempotent

Map a page into viewport-height bands with y bounds, element counts, and heading previews. Prefer get_page_outline regions (bundleTarget=true) over viewport bands; use regionIndex only when banding by viewport, not for micro-sections.

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": {
      "product": "<product>",
      "version": "<version>",
      "page": "<page>",
      "view": "<view>"
    },
    "name": "get_page_regions"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageYesCaptured page key returned by list_pages or get_application_manifest, not a URL or filesystem path.
viewYesExact stored profile key from list_pages.views (desktop, mobile, numbered profiles or a device label); do not pass the operating system here.
productYesProduct key, for example finance-ozon-ru
versionYesExact capture version returned by list_versions. Pin the same version across related calls; do not use latest as an alias.
environmentNoEnvironment ID from the selected backend platform type in list_platforms.options.platforms[].environments[].id (backend implementation). Omit only when the version has one captured environment. Use captured pairs from list_platforms/list_versions for actual availability.

Output Schema

NameRequiredDescriptionDefault
regionsYesResult entries
truncatedYesWhether this condition holds
scrollHeightYesMeasured value
viewportHeightYesMeasured value

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +true
    • changedOutput schema / description
      Previous value: -"Structured result. Existing text or image content remains available in content."New value: +"Viewport-sized regions of the captured page"
    • addedOutput schema / properties / regions
      Added value: +{
      +  "description": "Result entries",
      +  "items": {
      +    "additionalProperties": true,
      +    "description": "Viewport region",
      +    "properties": {
      +      "elementCount": {
      +        "description": "Count or zero-based index",
      +        "type": "integer"
      +      },
      +      "headings": {
      +        "description": "Result entries",
      +        "items": {
      +          "description": "Text value",
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "index": {
      +        "description": "Count or zero-based index",
      +        "type": "integer"
      +      },
      +      "yEnd": {
      +        "description": "Measured value",
      +        "type": "number"
      +      },
      +      "yStart": {
      +        "description": "Measured value",
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "index",
      +      "yStart",
      +      "yEnd",
      +      "elementCount",
      +      "headings"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / result
      Removed value: -{
      -  "additionalProperties": true,
      -  "description": "Viewport-sized regions of the captured page",
      -  "properties": {
      -    "regions": {
      -      "description": "Result entries",
      -      "items": {
      -        "additionalProperties": true,
      -        "description": "Viewport region",
      -        "properties": {
      -          "elementCount": {
      -            "description": "Count or zero-based index",
      -            "type": "integer"
      -          },
      -          "headings": {
      -            "description": "Result entries",
      -            "items": {
      -              "description": "Text value",
      -              "type": "string"
      -            },
      -            "type": "array"
      -          },
      -          "index": {
      -            "description": "Count or zero-based index",
      -            "type": "integer"
      -          },
      -          "yEnd": {
      -            "description": "Measured value",
      -            "type": "number"
      -          },
      -          "yStart": {
      -            "description": "Measured value",
      -            "type": "number"
      -          }
      -        },
      -        "required": [
      -          "index",
      -          "yStart",
      -          "yEnd",
      -          "elementCount",
      -          "headings"
      -        ],
      -        "type": "object"
      -      },
      -      "type": "array"
      -    },
      -    "scrollHeight": {
      -      "description": "Measured value",
      -      "type": "number"
      -    },
      -    "truncated": {
      -      "description": "Whether this condition holds",
      -      "type": "boolean"
      -    },
      -    "viewportHeight": {
      -      "description": "Measured value",
      -      "type": "number"
      -    }
      -  },
      -  "required": [
      -    "viewportHeight",
      -    "scrollHeight",
      -    "truncated",
      -    "regions"
      -  ],
      -  "type": "object"
      -}
    • addedOutput schema / properties / scrollHeight
      Added value: +{
      +  "description": "Measured value",
      +  "type": "number"
      +}
    • addedOutput schema / properties / truncated
      Added value: +{
      +  "description": "Whether this condition holds",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / viewportHeight
      Added value: +{
      +  "description": "Measured value",
      +  "type": "number"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "result"
      -]New value: +[
      +  "viewportHeight",
      +  "scrollHeight",
      +  "truncated",
      +  "regions"
      +]
  2. Changed4 schema fields changed
    • addedInput schema / properties / page / description
      Added value: +"Captured page key returned by list_pages or get_application_manifest, not a URL or filesystem path."
    • addedInput schema / properties / product / description
      Added value: +"Product key, for example finance-ozon-ru"
    • addedInput schema / properties / version / description
      Added value: +"Exact capture version returned by list_versions. Pin the same version across related calls; do not use latest as an alias."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": false,
      +  "description": "Structured result. Existing text or image content remains available in content.",
      +  "properties": {
      +    "result": {
      +      "additionalProperties": true,
      +      "description": "Viewport-sized regions of the captured page",
      +      "properties": {
      +        "regions": {
      +          "description": "Result entries",
      +          "items": {
      +            "additionalProperties": true,
      +            "description": "Viewport region",
      +            "properties": {
      +              "elementCount": {
      +                "description": "Count or zero-based index",
      +                "type": "integer"
      +              },
      +              "headings": {
      +                "description": "Result entries",
      +                "items": {
      +                  "description": "Text value",
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "index": {
      +                "description": "Count or zero-based index",
      +                "type": "integer"
      +              },
      +              "yEnd": {
      +                "description": "Measured value",
      +                "type": "number"
      +              },
      +              "yStart": {
      +                "description": "Measured value",
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "index",
      +              "yStart",
      +              "yEnd",
      +              "elementCount",
      +              "headings"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "scrollHeight": {
      +          "description": "Measured value",
      +          "type": "number"
      +        },
      +        "truncated": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "viewportHeight": {
      +          "description": "Measured value",
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "viewportHeight",
      +        "scrollHeight",
      +        "truncated",
      +        "regions"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, and an output schema exists, so the description's mention of band contents adds little beyond structured fields. It does not state cost, page-size limits, or how many bands are returned, so beyond the safety profile already supplied there is only modest added context.

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?

Two sentences, front-loaded with the core purpose and then the routing rule; nothing is padding. The jargon ('bundleTarget=true', 'regionIndex', 'micro-sections') is dense and undefined, costing a bit of clarity for the brevity gained.

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?

Return shape is covered by the output schema, safety by annotations, and inputs by complete schema descriptions, so the description only needs to supply purpose and sibling routing, which it does. Nothing an agent needs to call this correctly appears to be missing.

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 page, view, product, version and environment are already fully documented with strong disambiguation (e.g. view vs operating system, version vs 'latest'). The description adds no parameter-level meaning and introduces 'regionIndex', a name that does not appear in this schema, which is mildly confusing rather than clarifying.

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?

The first sentence gives a specific verb and resource ('Map a page into viewport-height bands') plus the concrete outputs (y bounds, element counts, heading previews), which makes the tool's granularity distinguishable from get_page_outline at a glance.

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?

It explicitly routes the agent away from this tool toward get_page_outline regions (bundleTarget=true) and warns against using banding for micro-sections. The gap is that 'regionIndex' is not a parameter of this tool, so the second clause points at something the agent cannot act on here, leaving the positive 'use this when you want viewport bands' case only implied.

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