Skip to main content
Glama

List pages

list_pages
Read-onlyIdempotent

Search and paginate captured pages in the selected environment. Optionally filter by platform type. views[] contains exact stored profile keys, platform type (null for legacy unclassified labels), and environment. Use these keys for page tools; desktop/mobile flags are legacy conveniences.

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>"
    },
    "name": "list_pages"
  }
}

Input Schema

NameRequiredDescriptionDefault
roleNoFilter by semantic page role; missing semantics does not match.
limitNoMaximum items returned, clamped to 1..100. Default 50.
queryNoCase-insensitive search text. Empty means no filter; matches the fields documented by this tool.
offsetNoZero-based result offset for pagination. Negative values are treated as zero; default is 0.
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.
platformNoPlatform type ID from list_platforms.options.platforms[].id (backend CatalogPlatform.view). Use backend IDs verbatim; desktop/mobile are current examples. Environment is selected separately.
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
pagesYesResult entries
totalYesCount or zero-based index
offsetYesCount or zero-based index
environmentYesText value

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / role
      Added value: +{
      +  "default": "",
      +  "description": "Filter by semantic page role; missing semantics does not match.",
      +  "type": "string"
      +}
  2. 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: +"Paginated captured pages in the selected environment"
    • addedOutput schema / properties / environment
      Added value: +{
      +  "description": "Text value",
      +  "type": "string"
      +}
    • addedOutput schema / properties / offset
      Added value: +{
      +  "description": "Count or zero-based index",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / pages
      Added value: +{
      +  "description": "Result entries",
      +  "items": {
      +    "$ref": "#/$defs/pageEntry"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / result
      Removed value: -{
      -  "additionalProperties": true,
      -  "description": "Paginated captured pages in the selected environment",
      -  "properties": {
      -    "environment": {
      -      "description": "Text value",
      -      "type": "string"
      -    },
      -    "offset": {
      -      "description": "Count or zero-based index",
      -      "type": "integer"
      -    },
      -    "pages": {
      -      "description": "Result entries",
      -      "items": {
      -        "$ref": "#/$defs/pageEntry"
      -      },
      -      "type": "array"
      -    },
      -    "total": {
      -      "description": "Count or zero-based index",
      -      "type": "integer"
      -    }
      -  },
      -  "required": [
      -    "environment",
      -    "total",
      -    "offset",
      -    "pages"
      -  ],
      -  "type": "object"
      -}
    • addedOutput schema / properties / total
      Added value: +{
      +  "description": "Count or zero-based index",
      +  "type": "integer"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "result"
      -]New value: +[
      +  "environment",
      +  "total",
      +  "offset",
      +  "pages"
      +]
  3. Changed7 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"Maximum items returned, clamped to 1..100. Default 50."
    • addedInput schema / properties / offset / description
      Added value: +"Zero-based result offset for pagination. Negative values are treated as zero; default is 0."
    • addedInput schema / properties / platform / description
      Added value: +"Platform type ID from list_platforms.options.platforms[].id (backend CatalogPlatform.view). Use backend IDs verbatim; desktop/mobile are current examples. Environment is selected separately."
    • addedInput schema / properties / product / description
      Added value: +"Product key, for example finance-ozon-ru"
    • addedInput schema / properties / query / description
      Added value: +"Case-insensitive search text. Empty means no filter; matches the fields documented by this tool."
    • 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": {
      +    "pageEntry": {
      +      "additionalProperties": true,
      +      "description": "Captured page inventory entry",
      +      "properties": {
      +        "desktop": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "error": {
      +          "anyOf": [
      +            {
      +              "description": "Text value",
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "mobile": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "name": {
      +          "description": "name",
      +          "type": "string"
      +        },
      +        "url": {
      +          "anyOf": [
      +            {
      +              "description": "Text value",
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "views": {
      +          "description": "Result entries",
      +          "items": {
      +            "$ref": "#/$defs/view"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "name",
      +        "views",
      +        "url",
      +        "error",
      +        "desktop",
      +        "mobile"
      +      ],
      +      "type": "object"
      +    },
      +    "view": {
      +      "additionalProperties": true,
      +      "description": "Stored view profile and captured platform/environment",
      +      "properties": {
      +        "environment": {
      +          "description": "Text value",
      +          "type": "string"
      +        },
      +        "platform": {
      +          "anyOf": [
      +            {
      +              "description": "Text value",
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "view": {
      +          "description": "Text value",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "view",
      +        "platform",
      +        "environment"
      +      ],
      +      "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": "Paginated captured pages in the selected environment",
      +      "properties": {
      +        "environment": {
      +          "description": "Text value",
      +          "type": "string"
      +        },
      +        "offset": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        },
      +        "pages": {
      +          "description": "Result entries",
      +          "items": {
      +            "$ref": "#/$defs/pageEntry"
      +          },
      +          "type": "array"
      +        },
      +        "total": {
      +          "description": "Count or zero-based index",
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "environment",
      +        "total",
      +        "offset",
      +        "pages"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  4. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description still adds real value by warning that views[] platform type can be null for legacy unclassified labels and that desktop/mobile flags are legacy conveniences an agent should not rely on — both are non-obvious behavioral caveats.

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 short sentences with the primary action and scope front-loaded, then return-key semantics. It is efficient, though the second sentence is telegraphic ('views[] contains exact stored profile keys, platform type (null for legacy unclassified labels), and environment') and would read more clearly with phrasing tying it to the response.

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 an output schema present and full parameter coverage, the description need not explain return values, yet it usefully annotates the important ones. It covers scope, filtering and pagination, and version pinning is handled by the schema; only the relative positioning against other listing tools is thin.

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% and the parameter docs already explain product, version, platform, environment, limit and offset in detail. The description only echoes the platform filter and restates the environment scoping, adding no syntax or format meaning beyond the schema, so the 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?

States a specific verb pair (search and paginate) and resource (captured pages) with scope (selected environment) plus an optional platform filter. It is clearly distinguishable from siblings like list_flows or list_assets by resource, but it never names an alternative tool or explicitly contrasts its role.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies usage (search/paginate captured pages in the current environment, optionally narrowed by platform) and points forward with 'Use these keys for page tools,' but gives no explicit when-to-use vs when-not, and no stated relationship to list_versions or list_platforms beyond a bare mention.

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