Skip to main content
Glama

Get page outline

get_page_outline
Read-onlyIdempotent

Batch IR entry: list page sections plus regions (bundleTarget=true top-level). Call this first, then one get_section_bundle / get_page_bundles per region only — nested outline leaves are structure hints, not separate bundle targets.

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_outline"
  }
}

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
guidanceYesText value
sectionsYesResult entries
truncatedYesWhether this condition holds
regionCountYesCount or zero-based index
scrollHeightYesMeasured value
sectionCountYesCount or zero-based index
viewportHeightYesMeasured value

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 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: +"Measured page structure and recommended bundle regions"
    • addedOutput schema / properties / guidance
      Added value: +{
      +  "description": "Text value",
      +  "type": "string"
      +}
    • addedOutput schema / properties / regionCount
      Added value: +{
      +  "description": "Count or zero-based index",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / regions
      Added value: +{
      +  "description": "Result entries",
      +  "items": {
      +    "$ref": "#/$defs/outlineSection"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / result
      Removed value: -{
      -  "additionalProperties": true,
      -  "description": "Measured page structure and recommended bundle regions",
      -  "properties": {
      -    "guidance": {
      -      "description": "Text value",
      -      "type": "string"
      -    },
      -    "regionCount": {
      -      "description": "Count or zero-based index",
      -      "type": "integer"
      -    },
      -    "regions": {
      -      "description": "Result entries",
      -      "items": {
      -        "$ref": "#/$defs/outlineSection"
      -      },
      -      "type": "array"
      -    },
      -    "scrollHeight": {
      -      "description": "Measured value",
      -      "type": "number"
      -    },
      -    "sectionCount": {
      -      "description": "Count or zero-based index",
      -      "type": "integer"
      -    },
      -    "sections": {
      -      "description": "Result entries",
      -      "items": {
      -        "$ref": "#/$defs/outlineSection"
      -      },
      -      "type": "array"
      -    },
      -    "truncated": {
      -      "description": "Whether this condition holds",
      -      "type": "boolean"
      -    },
      -    "viewportHeight": {
      -      "description": "Measured value",
      -      "type": "number"
      -    }
      -  },
      -  "required": [
      -    "viewportHeight",
      -    "scrollHeight",
      -    "truncated",
      -    "guidance",
      -    "sectionCount",
      -    "regionCount",
      -    "regions",
      -    "sections"
      -  ],
      -  "type": "object"
      -}
    • addedOutput schema / properties / scrollHeight
      Added value: +{
      +  "description": "Measured value",
      +  "type": "number"
      +}
    • addedOutput schema / properties / sectionCount
      Added value: +{
      +  "description": "Count or zero-based index",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / sections
      Added value: +{
      +  "description": "Result entries",
      +  "items": {
      +    "$ref": "#/$defs/outlineSection"
      +  },
      +  "type": "array"
      +}
    • 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",
      +  "guidance",
      +  "sectionCount",
      +  "regionCount",
      +  "regions",
      +  "sections"
      +]
  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: +{
      +  "$defs": {
      +    "outlineSection": {
      +      "additionalProperties": true,
      +      "description": "Measured outline section",
      +      "properties": {
      +        "bbox": {
      +          "$ref": "#/$defs/rect"
      +        },
      +        "bundleTarget": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "childCount": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        },
      +        "id": {
      +          "description": "Captured element ID",
      +          "type": "integer"
      +        },
      +        "nested": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "parent": {
      +          "anyOf": [
      +            {
      +              "description": "Parent element ID",
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "role": {
      +          "description": "role",
      +          "type": "string"
      +        },
      +        "tag": {
      +          "description": "tag",
      +          "type": "string"
      +        },
      +        "textPreview": {
      +          "description": "textPreview",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "parent",
      +        "role",
      +        "tag",
      +        "textPreview",
      +        "bbox",
      +        "childCount",
      +        "nested",
      +        "bundleTarget"
      +      ],
      +      "type": "object"
      +    },
      +    "rect": {
      +      "additionalProperties": true,
      +      "description": "Captured CSS-pixel rectangle",
      +      "properties": {
      +        "height": {
      +          "description": "height",
      +          "type": "number"
      +        },
      +        "width": {
      +          "description": "width",
      +          "type": "number"
      +        },
      +        "x": {
      +          "description": "x",
      +          "type": "number"
      +        },
      +        "y": {
      +          "description": "y",
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "$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": "Measured page structure and recommended bundle regions",
      +      "properties": {
      +        "guidance": {
      +          "description": "Text value",
      +          "type": "string"
      +        },
      +        "regionCount": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        },
      +        "regions": {
      +          "description": "Result entries",
      +          "items": {
      +            "$ref": "#/$defs/outlineSection"
      +          },
      +          "type": "array"
      +        },
      +        "scrollHeight": {
      +          "description": "Measured value",
      +          "type": "number"
      +        },
      +        "sectionCount": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        },
      +        "sections": {
      +          "description": "Result entries",
      +          "items": {
      +            "$ref": "#/$defs/outlineSection"
      +          },
      +          "type": "array"
      +        },
      +        "truncated": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "viewportHeight": {
      +          "description": "Measured value",
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "viewportHeight",
      +        "scrollHeight",
      +        "truncated",
      +        "guidance",
      +        "sectionCount",
      +        "regionCount",
      +        "regions",
      +        "sections"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.9/5.0
Behavior4/5

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

The annotations already declare this read-only, idempotent and non-destructive, so the safety profile is covered. The description adds genuinely new behavioral context beyond them: the hierarchy that regions are top-level (bundleTarget=true) while nested leaves are 'structure hints', and the downstream call pattern that follows this one. Return shape is left to the output schema, which is reasonable.

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 compact sentences, both front-loaded and free of filler. Density is a minor cost: 'bundleTarget=true top-level' is compressed to the point of being opaque without prior knowledge of the bundle model.

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?

For a read-only structural listing with a full output schema and fully documented parameters, the description covers the essential thing an agent needs: where this call sits in the call sequence and what not to do next. The unlabeled 'bundleTarget' concept is the main residual gap, but it does not block correct invocation.

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%, with detailed per-parameter text covering page keys, view profiles, version pinning and environment IDs, so the schema already carries the parameter burden. The description adds no meaning to any of the five parameters and instead spends its words on workflow; baseline 3 applies.

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 names a concrete verb and resource ('list page sections plus regions') and pins the scope with 'bundleTarget=true top-level', so an agent knows this is the structural overview call rather than a detail fetch. It is weaker on sibling differentiation: a reader cannot tell from this text alone how get_page_outline differs from the adjacent get_page_regions or get_page_summary tools, and 'Batch IR entry' is unexplained jargon.

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 gives explicit sequencing ('Call this first, then one get_section_bundle / get_page_bundles per region only') and a concrete misuse warning ('nested outline leaves are structure hints, not separate bundle targets'). That is strong when-to-use/when-not guidance, but it offers no rule for choosing between this and get_page_regions or get_page_summary, which are equally plausible entry points.

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