Skip to main content
Glama

Get Variable Schema

get_variable_schema
Read-onlyIdempotent

Get the schema for binding a script variable to a dataset, including the accepted update and selection strategies. A variable is a named row cursor bound to one whole dataset by dataSetId: on each pull it holds an entire row, advancing per occurrence, per iteration, or per bot ('vuser') depending on updateStrategy, with rows taken sequentially or randomly per selectionStrategy. Reference it as ${name} in command fields or bot.getVariable('name') in Playwright code. After changing bindings or references, run validate_script to cross-check them.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already mark the call read-only/idempotent/non-destructive, and the description adds substantial behavioral context: variables act as cursors, advancing per occurrence/iteration/bot depending on updateStrategy and choosing rows sequentially/randomly via selectionStrategy. It also documents reference syntax and the follow-up validation step, going well beyond the structured fields.

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?

Four sentences, each earning its place: purpose, variable semantics, reference syntax, and post-edit validation. The most important identification information is front-loaded and the description avoids repetition of the title or annotations.

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 no-argument metadata getter, the description covers what the schema contains and how to use the result, and it works well with the read-only annotations. It could be more complete by explicitly describing the shape/format of the returned schema, but the lack of an output schema makes this a minor gap rather than a critical omission.

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?

The input schema has zero parameters, so there is no missing parameter documentation; the baseline for no-parameter tools is 4. The description adds useful domain semantics (dataSetId, updateStrategy, selectionStrategy) even though those are concepts in the returned schema rather than call parameters.

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 names a specific verb and resource: 'Get the schema for binding a script variable to a dataset,' including update/selection strategies. This is clearly distinct from sibling tools like get_command_schema because it focuses on script variable-to-dataset binding.

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?

The description gives clear context for when the tool is relevant: when working with script variable bindings and their strategies, and it advises running validate_script after changing bindings/references. It does not explicitly name alternatives or state when not to use it, but the intended use is clear.

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.