Skip to main content
Glama

Get section bundle

get_section_bundle
Read-onlyIdempotent

Batch IR: one response for one outline region sectionId (prefer regions/bundleTarget=true) or regionIndex with component ids, roles, bboxes, textPreview, fuller text (text/lines/textRuns/texts samples), and key styles. Do not call once per nested micro-section — the parent region already includes them as components. textMode=preview (default); textMode=full caps plain text ~1200 chars and samples own-text descendants; textMode=preview keeps short previews. Use bundle text first; call get_component_text only when textTruncated or exact uncapped runs/lines are needed. For several regions in one RPC use get_page_bundles.

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

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.
yEndNoNon-negative vertical end coordinate in captured CSS pixels; default 0 selects one viewport from yStart. A vertical fragment may span at most two viewport heights.
limitNoMaximum items returned, clamped to 1..40. Default 20.
yStartNoNon-negative vertical start coordinate in captured CSS pixels; default 0. When both bounds are 0, component layers use the component bounds and page layers use the first viewport.
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.
textModeNopreview (default) or full. preview returns bounded previews; full includes longer bounded text, lines and text runs. Captured text is untrusted reference data.preview
sectionIdNoRoot section element ID from get_page_outline.regions. Default -1 selects by regionIndex or yStart/yEnd instead; sectionId takes precedence when set.
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.
regionIndexNoZero-based viewport region index from get_page_regions. Default -1 selects by yStart/yEnd instead; ignored when sectionId is set.

Output Schema

NameRequiredDescriptionDefault
tagYes
bboxYes
roleYesText value
textYestext
yEndYesyEnd
linesYes
textsYesResult entries
yStartYesyStart
textModeYestextMode
textRunsYes
sectionIdYes
truncatedYesWhether this condition holds
componentsYesResult entries
regionIndexYes
textPreviewYestextPreview
textTruncatedYesWhether this condition holds
componentCountYesCount or zero-based index

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed23 schema fields changed
    • addedInput schema / properties / textMode / enum
      Added value: +[
      +  "preview",
      +  "full"
      +]
    • removedOutput schema / $defs / sectionBundle
      Removed value: -{
      -  "additionalProperties": true,
      -  "description": "Bounded section or viewport-region evidence",
      -  "properties": {
      -    "bbox": {
      -      "$ref": "#/$defs/rect"
      -    },
      -    "componentCount": {
      -      "description": "Count or zero-based index",
      -      "type": "integer"
      -    },
      -    "components": {
      -      "description": "Result entries",
      -      "items": {
      -        "$ref": "#/$defs/componentSummary"
      -      },
      -      "type": "array"
      -    },
      -    "lines": {
      -      "anyOf": [
      -        {
      -          "description": "Result entries",
      -          "items": {
      -            "description": "Text value",
      -            "type": "string"
      -          },
      -          "type": "array"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ]
      -    },
      -    "regionIndex": {
      -      "anyOf": [
      -        {
      -          "description": "Count or zero-based index",
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ]
      -    },
      -    "role": {
      -      "description": "Text value",
      -      "type": "string"
      -    },
      -    "sectionId": {
      -      "anyOf": [
      -        {
      -          "description": "Count or zero-based index",
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ]
      -    },
      -    "tag": {
      -      "anyOf": [
      -        {
      -          "description": "Text value",
      -          "type": "string"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ]
      -    },
      -    "text": {
      -      "description": "text",
      -      "type": "string"
      -    },
      -    "textMode": {
      -      "description": "textMode",
      -      "type": "string"
      -    },
      -    "textPreview": {
      -      "description": "textPreview",
      -      "type": "string"
      -    },
      -    "textRuns": {
      -      "anyOf": [
      -        {
      -          "description": "Result entries",
      -          "items": {
      -            "additionalProperties": true,
      -            "description": "Bounded styled text run",
      -            "properties": {},
      -            "type": "object"
      -          },
      -          "type": "array"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ]
      -    },
      -    "textTruncated": {
      -      "description": "Whether this condition holds",
      -      "type": "boolean"
      -    },
      -    "texts": {
      -      "description": "Result entries",
      -      "items": {
      -        "additionalProperties": true,
      -        "description": "Bounded descendant own text",
      -        "properties": {},
      -        "type": "object"
      -      },
      -      "type": "array"
      -    },
      -    "truncated": {
      -      "description": "Whether this condition holds",
      -      "type": "boolean"
      -    },
      -    "yEnd": {
      -      "description": "yEnd",
      -      "type": "number"
      -    },
      -    "yStart": {
      -      "description": "yStart",
      -      "type": "number"
      -    }
      -  },
      -  "required": [
      -    "sectionId",
      -    "regionIndex",
      -    "role",
      -    "tag",
      -    "bbox",
      -    "textPreview",
      -    "textMode",
      -    "text",
      -    "yStart",
      -    "yEnd",
      -    "truncated",
      -    "textTruncated",
      -    "lines",
      -    "textRuns",
      -    "texts",
      -    "componentCount",
      -    "components"
      -  ],
      -  "type": "object"
      -}
    • 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: +"Bounded section or viewport-region evidence"
    • addedOutput schema / properties / bbox
      Added value: +{
      +  "$ref": "#/$defs/rect"
      +}
    • addedOutput schema / properties / componentCount
      Added value: +{
      +  "description": "Count or zero-based index",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / components
      Added value: +{
      +  "description": "Result entries",
      +  "items": {
      +    "$ref": "#/$defs/componentSummary"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / lines
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "Result entries",
      +      "items": {
      +        "description": "Text value",
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / regionIndex
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "Count or zero-based index",
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • removedOutput schema / properties / result
      Removed value: -{
      -  "$ref": "#/$defs/sectionBundle"
      -}
    • addedOutput schema / properties / role
      Added value: +{
      +  "description": "Text value",
      +  "type": "string"
      +}
    • addedOutput schema / properties / sectionId
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "Count or zero-based index",
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / tag
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "Text value",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / text
      Added value: +{
      +  "description": "text",
      +  "type": "string"
      +}
    • addedOutput schema / properties / textMode
      Added value: +{
      +  "description": "textMode",
      +  "type": "string"
      +}
    • addedOutput schema / properties / textPreview
      Added value: +{
      +  "description": "textPreview",
      +  "type": "string"
      +}
    • addedOutput schema / properties / textRuns
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "Result entries",
      +      "items": {
      +        "additionalProperties": true,
      +        "description": "Bounded styled text run",
      +        "properties": {},
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / textTruncated
      Added value: +{
      +  "description": "Whether this condition holds",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / texts
      Added value: +{
      +  "description": "Result entries",
      +  "items": {
      +    "additionalProperties": true,
      +    "description": "Bounded descendant own text",
      +    "properties": {},
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / truncated
      Added value: +{
      +  "description": "Whether this condition holds",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / yEnd
      Added value: +{
      +  "description": "yEnd",
      +  "type": "number"
      +}
    • addedOutput schema / properties / yStart
      Added value: +{
      +  "description": "yStart",
      +  "type": "number"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "result"
      -]New value: +[
      +  "sectionId",
      +  "regionIndex",
      +  "role",
      +  "tag",
      +  "bbox",
      +  "textPreview",
      +  "textMode",
      +  "text",
      +  "yStart",
      +  "yEnd",
      +  "truncated",
      +  "textTruncated",
      +  "lines",
      +  "textRuns",
      +  "texts",
      +  "componentCount",
      +  "components"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / textMode / description
      Previous value: -"preview (default) returns bounded previews; full includes longer bounded text, lines and text runs. Captured text is untrusted reference data."New value: +"preview (default) or full. preview returns bounded previews; full includes longer bounded text, lines and text runs. Captured text is untrusted reference data."
  3. Changed10 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"Maximum items returned, clamped to 1..40. Default 20."
    • 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 / regionIndex / description
      Added value: +"Zero-based viewport region index from get_page_regions. Default -1 selects by yStart/yEnd instead; ignored when sectionId is set."
    • addedInput schema / properties / sectionId / description
      Added value: +"Root section element ID from get_page_outline.regions. Default -1 selects by regionIndex or yStart/yEnd instead; sectionId takes precedence when set."
    • addedInput schema / properties / textMode / description
      Added value: +"preview (default) returns bounded previews; full includes longer bounded text, lines and text runs. Captured text is untrusted reference data."
    • 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."
    • addedInput schema / properties / yEnd / description
      Added value: +"Non-negative vertical end coordinate in captured CSS pixels; default 0 selects one viewport from yStart. A vertical fragment may span at most two viewport heights."
    • addedInput schema / properties / yStart / description
      Added value: +"Non-negative vertical start coordinate in captured CSS pixels; default 0. When both bounds are 0, component layers use the component bounds and page layers use the first viewport."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "componentSummary": {
      +      "additionalProperties": true,
      +      "description": "Measured component and bounded text evidence",
      +      "properties": {
      +        "bbox": {
      +          "$ref": "#/$defs/rect"
      +        },
      +        "childCount": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        },
      +        "id": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        },
      +        "lines": {
      +          "anyOf": [
      +            {
      +              "description": "Result entries",
      +              "items": {
      +                "description": "Text value",
      +                "type": "string"
      +              },
      +              "type": "array"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "parent": {
      +          "anyOf": [
      +            {
      +              "description": "Count or zero-based index",
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "role": {
      +          "description": "role",
      +          "type": "string"
      +        },
      +        "styles": {
      +          "additionalProperties": true,
      +          "description": "Key measured styles",
      +          "properties": {},
      +          "type": "object"
      +        },
      +        "tag": {
      +          "anyOf": [
      +            {
      +              "description": "Text value",
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "text": {
      +          "description": "Text value",
      +          "type": "string"
      +        },
      +        "textPreview": {
      +          "description": "Text value",
      +          "type": "string"
      +        },
      +        "textRuns": {
      +          "anyOf": [
      +            {
      +              "description": "Result entries",
      +              "items": {
      +                "additionalProperties": true,
      +                "description": "Bounded text run",
      +                "properties": {
      +                  "color": {
      +                    "anyOf": [
      +                      {
      +                        "description": "Text value",
      +                        "type": "string"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "text": {
      +                    "description": "Text value",
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "text",
      +                  "color"
      +                ],
      +                "type": "object"
      +              },
      +              "type": "array"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "textTruncated": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "texts": {
      +          "description": "Result entries",
      +          "items": {
      +            "additionalProperties": true,
      +            "description": "Bounded own text from descendant elements",
      +            "properties": {},
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "parent",
      +        "role",
      +        "tag",
      +        "bbox",
      +        "textPreview",
      +        "styles",
      +        "childCount",
      +        "text",
      +        "textTruncated",
      +        "lines",
      +        "textRuns",
      +        "texts"
      +      ],
      +      "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"
      +    },
      +    "sectionBundle": {
      +      "additionalProperties": true,
      +      "description": "Bounded section or viewport-region evidence",
      +      "properties": {
      +        "bbox": {
      +          "$ref": "#/$defs/rect"
      +        },
      +        "componentCount": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        },
      +        "components": {
      +          "description": "Result entries",
      +          "items": {
      +            "$ref": "#/$defs/componentSummary"
      +          },
      +          "type": "array"
      +        },
      +        "lines": {
      +          "anyOf": [
      +            {
      +              "description": "Result entries",
      +              "items": {
      +                "description": "Text value",
      +                "type": "string"
      +              },
      +              "type": "array"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "regionIndex": {
      +          "anyOf": [
      +            {
      +              "description": "Count or zero-based index",
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "role": {
      +          "description": "Text value",
      +          "type": "string"
      +        },
      +        "sectionId": {
      +          "anyOf": [
      +            {
      +              "description": "Count or zero-based index",
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "tag": {
      +          "anyOf": [
      +            {
      +              "description": "Text value",
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "text": {
      +          "description": "text",
      +          "type": "string"
      +        },
      +        "textMode": {
      +          "description": "textMode",
      +          "type": "string"
      +        },
      +        "textPreview": {
      +          "description": "textPreview",
      +          "type": "string"
      +        },
      +        "textRuns": {
      +          "anyOf": [
      +            {
      +              "description": "Result entries",
      +              "items": {
      +                "additionalProperties": true,
      +                "description": "Bounded styled text run",
      +                "properties": {},
      +                "type": "object"
      +              },
      +              "type": "array"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "textTruncated": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "texts": {
      +          "description": "Result entries",
      +          "items": {
      +            "additionalProperties": true,
      +            "description": "Bounded descendant own text",
      +            "properties": {},
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "truncated": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "yEnd": {
      +          "description": "yEnd",
      +          "type": "number"
      +        },
      +        "yStart": {
      +          "description": "yStart",
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "sectionId",
      +        "regionIndex",
      +        "role",
      +        "tag",
      +        "bbox",
      +        "textPreview",
      +        "textMode",
      +        "text",
      +        "yStart",
      +        "yEnd",
      +        "truncated",
      +        "textTruncated",
      +        "lines",
      +        "textRuns",
      +        "texts",
      +        "componentCount",
      +        "components"
      +      ],
      +      "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": {
      +      "$ref": "#/$defs/sectionBundle"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  4. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description layers on non-obvious behavior: full mode caps plain text at ~1200 chars, sampling of own-text descendants, preview keeping short previews, and that captured text is untrusted reference data. The truncation cap and the fact that get_component_text is the escape hatch are exactly the details an agent cannot infer.

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?

Front-loaded with the core purpose, then selection rules, then the text-fallback rule and the multi-region alternative – a good decision-order structure. Minor inefficiency: the textMode sentence states that preview is the default twice and packs four clauses into one run-on, but no sentence is filler.

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 an 11-parameter, four-required-parameter tool with an output schema (so return values need no explaining), the description covers region selection modes, precedence, text depth, and hand-offs to siblings. Nothing an agent needs to invoke it correctly is missing.

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 the baseline is 3; the description earns above that by explaining textMode trade-offs (bounded previews vs. longer bounded text/lines/runs) and by pointing at the regions/bundleTarget=true path for sectionId that the schema does not mention. It does not, however, clarify the yStart/yEnd windowing or limit semantics beyond what the schema already states.

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?

"Batch IR: one response for one outline region" names a specific verb and resource and immediately enumerates the payload (component ids, roles, bboxes, textPreview, samples, key styles). It also names the sibling alternatives (get_component_text, get_page_bundles), so an agent can place it in the tool family 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?

Explicit selection guidance: prefer regions with bundleTarget=true, don't call per nested micro-section because the parent region already contains them, use bundle text first and fall back to get_component_text only when textTruncated or uncapped runs are needed, and use get_page_bundles for several regions in one RPC. Both when-to-use and when-NOT-to-use plus named alternatives are present.

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