Skip to main content
Glama

List component candidates

list_component_candidates
Read-onlyIdempotent

List candidate visual components in a page viewport. IDs are element indexes; candidates are heuristic, not verified reusable UI components.

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": "list_component_candidates"
  }
}

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.
limitNoMaximum items returned, clamped to 1..200. Default 100.
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
resultYesResult entries

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / description
      Previous value: -"Structured result. Existing text or image content remains available in content."New value: +"Structured result wrapping a non-object value. The text content holds the same value unwrapped."
  2. Changed5 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"Maximum items returned, clamped to 1..200. Default 100."
    • 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": {
      +    "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": {
      +      "description": "Result entries",
      +      "items": {
      +        "additionalProperties": true,
      +        "description": "Candidate visual region",
      +        "properties": {
      +          "id": {
      +            "description": "Count or zero-based index",
      +            "type": "integer"
      +          },
      +          "label": {
      +            "description": "Text value",
      +            "type": "string"
      +          },
      +          "rect": {
      +            "anyOf": [
      +              {
      +                "$ref": "#/$defs/rect"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "tag": {
      +            "anyOf": [
      +              {
      +                "description": "Text value",
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "tag",
      +          "label",
      +          "rect"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint, idempotentHint, destructiveHint=false), and the description adds genuinely new behavioral context: the returned IDs are element indexes, and the results are heuristic guesses rather than confirmed reusable components. That accuracy caveat is exactly the kind of thing an agent needs before trusting the output; only the absence of any note on ordering or cost keeps it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, zero filler, with the scope stated first and the reliability caveat immediately after. Every clause carries information the agent cannot get from the structured fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need no explanation, and the schema fully documents the six parameters. What is missing is the positioning relative to the many sibling listing/component tools, which for a discovery-style tool is the main open question an agent faces.

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 schema already explains each parameter in detail (page key source, exact view profile key, limit clamping, version pinning, environment selection). The description adds nothing about parameters, 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 and resource ('List candidate visual components') plus the scope ('in a page viewport'), and the qualifier 'candidates are heuristic, not verified reusable UI components' separates it from the verified-component siblings like get_component or get_page_components. It stops short of naming those siblings directly, so the differentiation is implicit rather than explicit.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance and no named alternative, despite a crowded sibling space (find_elements, get_elements, get_page_components, get_component_tree). The word 'candidate' hints this is a discovery step before verification, but the agent must infer that and guess which tool performs the verification.

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