Skip to main content
Glama

Get dataset items

get-dataset-items
Read-onlyIdempotent

Get items (rows) from a dataset — the output/results produced by an Actor run. Returns the rows themselves, not dataset metadata, counts, or a schema. When the user provides a datasetId and asks to retrieve results, output, data, or rows, call this tool directly. Default limit is 20. Use clean=true to skip empty items and hidden fields.

USAGE:

  • Use when you need to read data from a dataset (all items or only selected fields).

USAGE EXAMPLES:

  • user_input: Retrieve results from dataset abc123

  • user_input: Get only metadata.url and title from dataset username~my-dataset

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": {
      "datasetId": "<datasetId>"
    },
    "name": "get-dataset-items"
  }
}

Input Schema

NameRequiredDescriptionDefault
descNoIf true, results are returned in reverse order (newest to oldest).
omitNoComma-separated list of fields to exclude from results.
cleanNoIf true, returns only non-empty items and skips hidden fields (starting with #). Shortcut for skipHidden=true and skipEmpty=true.
limitNoMaximum number of items to return. Default is 20.
fieldsNoComma-separated list of fields to include in results. Fields in output are sorted as specified. Use dot notation for nested objects (e.g. "metadata.url"); the server auto-flattens parent prefixes and returns flat keys, unless the parent itself is listed (e.g. "metadata,metadata.url" returns metadata whole). A dotted path to or through an array (e.g. "results.url") returns nothing: select its top-level field (e.g. "results") for every element. Items that have none of the requested fields come back as {}, or are dropped when clean=true.
offsetNoNumber of items to skip at the start. Default is 0.
flattenNoComma-separated list of fields to flatten (e.g. flatten="metadata" turns {"metadata":{"url":"x"}} into {"metadata.url":"x"}). Normally derived automatically from dot-notation in `fields`; specify only as a diagnostic override.
datasetIdYesDataset ID, name (resolved against your own datasets), or full name as username~name.

Output Schema

NameRequiredDescriptionDefault
itemsYesDataset items
limitYesLimit used for pagination
offsetYesOffset used for pagination
summaryYesSummary of the result
nextStepYesOne follow-up action with tool name
datasetIdYesDataset ID
itemCountYesNumber of items returned
totalItemCountYesTotal items in dataset
apifyConsoleUrlNoPersonalized Apify Console link to the dataset; present only for Console sessions

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / datasetId / maxLength
      Added value: +256
  2. Changed2 schema fields changed
    • changedInput schema / properties / fields / description
      Previous value: -"Comma-separated list of fields to include in results. Fields in output are sorted as specified. Use dot notation for nested objects (e.g. \"metadata.url\"); the server auto-flattens parent prefixes."New value: +"Comma-separated list of fields to include in results.\nFields in output are sorted as specified.\nUse dot notation for nested objects (e.g. \"metadata.url\"); the server auto-flattens parent prefixes and returns flat keys, unless the parent itself is listed (e.g. \"metadata,metadata.url\" returns metadata whole).\nA dotted path to or through an array (e.g. \"results.url\") returns nothing: select its top-level field (e.g. \"results\") for every element.\nItems that have none of the requested fields come back as {}, or are dropped when clean=true."
    • changedInput schema / properties / flatten / description
      Previous value: -"Comma-separated list of fields to flatten (e.g. flatten=\"metadata\" turns {\"metadata\":{\"url\":\"x\"}} into {\"metadata.url\":\"x\"}). Normally derived automatically from dot-notation in `fields`; specify only as a diagnostic override."New value: +"Comma-separated list of fields to flatten (e.g. flatten=\"metadata\" turns {\"metadata\":{\"url\":\"x\"}} into {\"metadata.url\":\"x\"}).\nNormally derived automatically from dot-notation in `fields`; specify only as a diagnostic override."
  3. Changed1 schema field changed
    • changedInput schema / properties / datasetId / description
      Previous value: -"Dataset ID or username~dataset-name."New value: +"Dataset ID, name (resolved against your own datasets), or full name as username~name."
  4. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile needs no restating. The description adds that rows are returned rather than metadata and mentions the default limit of 20, but the clean=true behavior is simply the schema's own wording, and pagination/truncation behavior beyond the default is left unstated.

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?

The first two sentences carry the key information and are front-loaded; the USAGE block and examples are short and scan-friendly. There is mild redundancy — the default limit of 20 and the clean semantics appear in both the prose and the schema — but nothing is bloated.

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 schema coverage on all eight parameters, the description only needs to establish purpose and invocation context, which it does. The one remaining gap is that bulk/pagination behavior for large datasets (limit max, offset usage) is not framed narratively, though the schema covers it.

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 coverage is 100% and the schema descriptions are unusually thorough — the fields, flatten, offset, desc and omit parameters all carry detailed semantics. The description only repeats 'Default limit is 20' and 'clean=true skips empty items and hidden fields,' both of which are already fully documented in the schema, so it adds no new parameter meaning.

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 specific verb and resource ('Get items (rows) from a dataset') and immediately scopes it by saying the tool returns 'the rows themselves, not dataset metadata, counts, or a schema.' That negative scoping tells an agent exactly what this tool will not produce, which distinguishes it from dataset-metadata siblings without needing to name them.

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?

Gives a concrete trigger: when the user supplies a datasetId and asks for results, output, data, or rows, call it directly. Two usage examples reinforce the pattern. It stops short of naming an alternative tool or stating an explicit when-not-to-use condition, so it lands below a 5.

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.