Skip to main content
Glama

run_dataset

Read-only

Read rows from an existing dataset; may execute a source request on a cache miss. Use read_chart_results for saved dashboard summaries, get_chart_data for chart-shaped results, or explore_data to inspect sources and create datasets. Filters must use saved field paths rooted at root with exactly one [] row collection; date filters and cdc scope/IDs are not accepted. Refresh, non-empty variables, and forceSourceRefresh filters require data:refresh; otherwise the call fails.

Input Schema

NameRequiredDescriptionDefault
filtersNoRuntime filters; defaults to []. Field filter: {type:'field',field:'root[].status',operator:'is',value:'paid'}. Operators: is, isNot, contains, notContains, greaterThan, greaterOrEqual, lessThan, lessOrEqual, isNull, isNotNull. Only isNull/isNotNull may omit value. Optional forceSourceRefresh:true requires data:refresh. Tool-specific field and date rules apply; server limits can be lower than 50.
refreshNoBypass cached source data; requires data:refresh when true. False allows cache use but does not prevent source execution on a cache miss.
timezoneNoIANA timezone for dataset execution and filters, for example Europe/London. Defaults to UTC.
datasetIdYesSaved dataset ID from search_workspace or explore_data save. Must be accessible to the caller.
variablesNoMap of existing request variable names to JSON values, for example {region:'APAC'}. Defaults to {}. Any non-empty map requires data:refresh. Server size and nesting limits apply; do not use __proto__, constructor, or prototype keys.

Output Schema

NameRequiredDescriptionDefault
resultYesTool-specific result. Chart preview and filter write verification is returned in result.completion_check; completionRequirements is an input.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedInput schema / properties / datasetId / description
      Added value: +"Saved dataset ID from search_workspace or explore_data save. Must be accessible to the caller."
    • addedInput schema / properties / filters / description
      Added value: +"Runtime filters; defaults to []. Field filter: {type:'field',field:'root[].status',operator:'is',value:'paid'}. Operators: is, isNot, contains, notContains, greaterThan, greaterOrEqual, lessThan, lessOrEqual, isNull, isNotNull. Only isNull/isNotNull may omit value. Optional forceSourceRefresh:true requires data:refresh. Tool-specific field and date rules apply; server limits can be lower than 50."
    • addedInput schema / properties / filters / examples
      Added value: +[
      +  [
      +    {
      +      "field": "root[].status",
      +      "operator": "is",
      +      "type": "field",
      +      "value": "paid"
      +    }
      +  ]
      +]
    • addedInput schema / properties / refresh / description
      Added value: +"Bypass cached source data; requires data:refresh when true. False allows cache use but does not prevent source execution on a cache miss."
    • addedInput schema / properties / timezone / description
      Added value: +"IANA timezone for dataset execution and filters, for example Europe/London. Defaults to UTC."
    • addedInput schema / properties / variables / description
      Added value: +"Map of existing request variable names to JSON values, for example {region:'APAC'}. Defaults to {}. Any non-empty map requires data:refresh. Server size and nesting limits apply; do not use __proto__, constructor, or prototype keys."
    • addedOutput schema / properties / result / description
      Added value: +"Tool-specific result. Chart preview and filter write verification is returned in result.completion_check; completionRequirements is an input."
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond readOnlyHint/openWorldHint/destructiveHint, the description discloses the non-obvious behavior that a read can execute a source request on a cache miss, the exact authorization scope needed for refresh-class filters, and the failure mode ('otherwise the call fails'). It also discloses accepted filter shape constraints (saved field paths rooted at root with exactly one [] row collection) that annotations cannot express.

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 purpose and sibling routing, then constraints, then the permission gate — a sensible ordering. The prose is dense but each clause carries operational information; only the repeated data:refresh restatement is slightly duplicative.

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?

An output schema exists so return values need not be described; the remaining burden — permissions, cache-miss side effects, filter shape limits, and sibling routing — is all covered. Nothing an agent needs to invoke this 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 a bump by adding constraints not in the schema, notably the 'root[]' saved-field-path rule and the exclusion of date filters and cdc scope/IDs. It restates the data:refresh requirement already documented per-parameter, which is mildly redundant but reinforces the operational precondition.

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?

States a concrete verb and resource ('Read rows from an existing dataset') and immediately adds the key nuance that a cache miss may trigger a source request. It then explicitly distinguishes itself from three named siblings (read_chart_results, get_chart_data, explore_data), so an agent can route without opening schemas.

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?

Gives explicit routing rules: use read_chart_results for saved dashboard summaries, get_chart_data for chart-shaped results, explore_data to inspect sources and create datasets. It also states concrete when-not conditions (date filters and cdc scope/IDs are rejected) and the permission gate (data:refresh required for refresh, non-empty variables, forceSourceRefresh).

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