Skip to main content
Glama
Oxylabs Web API MCP Server

Oxylabs Web API MCP Server

Official

Read a long result in parts

read_result
Read-only

Retrieve truncated or long web search and scrape results by request_id, page, and offset; follow next_offset until eof to get only the needed content without triggering a new scrape.

Instructions

Read a long page of a result in parts, from where its reply cut it short.

Also reads a search_companies list that was cut to fit: that has one page, page=0, and no other page exists for it.

Use the request_id, page and next_offset that a summary, a cut page or the previous part gave, and keep calling with the next_offset each part returns until eof is true — and stop as soon as you have what you need rather than reading the whole page by reflex. Reading runs no new scrape: the page comes from disk where this server wrote it, or from the API, which keeps the results of queued requests. Returns text plus offset, returned_chars, total_chars, next_offset and eof.

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": {
      "request_id": "<request_id>"
    },
    "name": "read_result"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoWhich page of the result, counting from 0. Most results have one; a request for several pages of results, a search say, has more. A `search_companies` list is always page 0.
lengthNoMost characters to return; fewer come back if they would not fit.
offsetNoCharacter to start at: the `next_offset` a summary, a cut page or the previous part gave.
request_idYesThe `request_id` of the result to read.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.2

TDQS

A4.2/5.0
Behavior5/5

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

Beyond readOnlyHint/openWorldHint, it discloses data provenance ('the page comes from disk where this server wrote it, or from the API, which keeps the results of queued requests') and the important cost trait that reading performs no new scrape. That is exactly the kind of behavior an agent cannot get from the annotations and materially affects whether it is safe to re-read.

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 sentence front-loads the purpose and the second sentence carries the continuation protocol. Slightly overlong: the trailing enumeration of return fields (text, offset, returned_chars, total_chars, next_offset, eof) duplicates the output schema and is the one part that does not earn its space.

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, return values need not be explained, and the description covers the loop, provenance, and the search_companies special case. What is left unstated is failure behavior — e.g. what happens if a request_id has expired or the page no longer exists on disk.

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 above that by explaining the chaining relationship between parameters — offset should be the next_offset returned by the previous part, and page/request_id come from the prior response. It adds loop semantics rather than restating field definitions.

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?

The description names a specific verb and resource ('Read a long page of a result in parts') and adds a key scope distinction: 'Reading runs no new scrape,' which separates it from scrape. It never names a sibling outright, so an agent must infer the boundary rather than read it, which keeps this below a 5.

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?

It states the trigger clearly — use the request_id/page/next_offset that 'a summary, a cut page or the previous part gave' — and gives a stopping rule ('keep calling ... until eof is true' plus 'stop as soon as you have what you need'). It also carves out the search_companies case (always page 0, no other page). No explicit when-not-to-use beyond that, and no named alternative tool.

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