ATS Jobs API

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

Name	Required	Description
`desc`	No	If true, results are returned in reverse order (newest to oldest).
`omit`	No	Comma-separated list of fields to exclude from results.
`clean`	No	If true, returns only non-empty items and skips hidden fields (starting with #). Shortcut for skipHidden=true and skipEmpty=true.
`limit`	No	Maximum number of items to return. Default is 20.
`fields`	No	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 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.
`offset`	No	Number of items to skip at the start. Default is 0.
`flatten`	No	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.
`datasetId`	Yes	Dataset ID, name (resolved against your own datasets), or full name as username~name.

Output Schema

Name	Required	Description
`items`	Yes	Dataset items
`limit`	Yes	Limit used for pagination
`offset`	Yes	Offset used for pagination
`summary`	Yes	Summary of the result
`nextStep`	Yes	One follow-up action with tool name
`datasetId`	Yes	Dataset ID
`itemCount`	Yes	Number of items returned
`totalItemCount`	Yes	Total items in dataset
`apifyConsoleUrl`	No	Personalized Apify Console link to the dataset; present only for Console sessions

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedNov 10, 2026

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."

First observedNov 10, 2026

TDQS

A4.1/5.0

Behavior4/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 is covered. The description adds useful behavior beyond that: the default page size of 20 and the fact that clean=true filters empty items and hidden '#' fields. It does not mention pagination cost or dataset-size limits, keeping it below 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.

Conciseness4/5

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

Front-loaded with the core definition, then USAGE and examples in scannable blocks. Minor redundancy: the 'Default limit is 20' and clean=true explanations duplicate the schema's own parameter descriptions, and the USAGE bullet partly repeats the first paragraph.

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, the description needn't explain return values, and it correctly confines itself to what is returned conceptually plus key behavioral notes. For an 8-parameter read tool, the main missing piece is guidance on large datasets or pagination expectations, but the definition is otherwise sufficient to call correctly.

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%, including detailed notes on fields dot-notation, flatten override, and datasetId resolution, so the schema does the heavy lifting. The description restates only the limit default and the clean shortcut, both already documented in the schema, adding little new meaning — the baseline 3 for full coverage is appropriate.

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 what is returned: 'the rows themselves, not dataset metadata, counts, or a schema.' That negative scoping cleanly separates it from metadata/count-style siblings such as get-actor-run, so an agent can route without opening the schema.

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 an explicit trigger condition — 'When the user provides a datasetId and asks to retrieve results, output, data, or rows, call this tool directly' — plus a USAGE line and two concrete user_input examples. It lacks an explicit exclusion clause naming which tool to use instead when the user wants metadata rather than rows, so it falls short of full when/when-not routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All ATS Jobs API tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?