Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words Sign in

Web API MCP

✓ oxylabs.io

by oxylabsversion 0.3.1i★ 61iComputer or cloudOfficial site ↗
Registry nameio.oxylabs/web-api-mcp

How to install

What it does

Search the live web, look up companies and read any page through the Oxylabs Web API.

  • Connects Computer or cloud
  • Account or key Cloud: Needs Authorization · Local: Needs OXYLABS_WEB_API_KEY
  • Category Search & AI memory

Use together with

Skills that teach the AI this kind of work; they work alongside this one

timesfm

TimesFM (Time Series Foundation Model) is a pretrained time-series foundation model developed by Google Research for time-series forecasting.

by google-research★ 35,6421 skills

Skill · How-to guide

Shadowbroker

Open-source intelligence for the global theater. Track everything from the corporate/private jets of the wealthy, and spy satellites, to seismic events in one unified interface. Hook an AI agent up to have it parse through data and find previously unseen correlations. The knowledge is available to…

by BigBodyCobain★ 11,6081 skills

Skill · How-to guide

google-maps-scraper

scrape data from Google Maps. Extracts data such as the name, address, phone number, website URL, rating, reviews number, latitude and longitude, reviews,email and more for each place

by gosom★ 8,2561 skills

Skill · How-to guide

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity22/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering8/8The cloud endpoint answered at the last check
Usage score42/100

Quality: Passed 5/5 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install Web API MCP. Follow https://mcp.popnx.com/i/oxylabs-web-api-mcp.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 5/5 checks · What you ask goes through the maker’s server (mcp.oxylabs.io) · ✓ Commands checked Nov 20, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude · about 5 min

You need a Web API MCP key (create it on the maker’s site) · Set it up once on claude.ai or the desktop app, then use it in chat · free accounts can add 1 · on Team/Enterprise an Owner adds it

  1. Sign up and create a Web API MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the Web API MCP site ↗

  2. Open Claude’s Connectors page

    CustomizeConnectors

    CustomizeConnectors1Add2https://…3Add4
  3. Click “Add” → “Custom” → “Web” and fill in these 2 fields

    Copy each value into the field with the same name in Claude, then click Continue

    Name · NameWeb API MCP
    Remote MCP server URL · Addresshttps://mcp.oxylabs.io/web-api-mcp

    Under Request headers, add this name and value

    Header nameAuthorization
    ValueBearer <paste your key here>

    Paste the key only into the app’s field, never into a chat or to anyone

    Click Continue past the sign-in settings Claude detected · under Authentication choose what the maker says (Sign in now, Sign in when needed or No sign in), then click Add

  4. Turn it on in a chat

    +ConnectorsWeb API MCP

  5. Try it

    Use Web API MCP and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using Web API MCP or shows a Web API MCP tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect Web API MCP yet

Web API MCP needs your own key to connect, but OpenAI’s help page only describes OAuth sign-in; there is no key option we could verify

What you can do instead

A · Use an app that can connect Web API MCP

  • You need a Web API MCP key (create it on the maker’s site) · Set it up once on claude.ai or the desktop app, then use it in chat · free accounts can add 1 · on Team/Enterprise an Owner adds it
  • You need a Web API MCP key (create it on the maker’s site)
  • You need a Web API MCP key (create it on the maker’s site)
  • You need a Web API MCP key (create it on the maker’s site)

B · Others in Search & AI memory that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code · about 5 min

You need a Web API MCP key (create it on the maker’s site)

  1. Sign up and create a Web API MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the Web API MCP site ↗

  2. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  3. Paste this command and press Enter

    claude mcp add --transport http --scope user web-api https://mcp.oxylabs.io/web-api-mcp --header 'Authorization: Bearer {api_key}'

    Replace “your-value” with your key before pressing Enter

    Paste the key only into the app’s field, never into a chat or to anyone

  4. Type /mcp in Claude Code

    You should see Web API MCP listed as connected

  5. Try it

    Use Web API MCP and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using Web API MCP or shows a Web API MCP tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor · about 5 min

You need a Web API MCP key (create it on the maker’s site)

  1. Sign up and create a Web API MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the Web API MCP site ↗

  2. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  3. Fill in your key

    In the Web API MCP settings, Authorization is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  4. Open the AI chat in Cursor in Agent mode

  5. Try it

    Use Web API MCP and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using Web API MCP or shows a Web API MCP tool in the answer, you are connected

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code · about 5 min

You need a Web API MCP key (create it on the maker’s site)

  1. Sign up and create a Web API MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the Web API MCP site ↗

  2. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  3. Fill in your key

    In the Web API MCP settings, Authorization is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  4. Open the AI chat in VS Code in Agent mode

  5. Try it

    Use Web API MCP and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using Web API MCP or shows a Web API MCP tool in the answer, you are connected

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

Address for apps that connect over the web

Addresshttps://mcp.oxylabs.io/web-api-mcp

JSON settings are under “For developers” below

Stuck? Ask people who use Web API MCP💬 Discussion →
For developers: Terminal commands and JSON settings

Over the web

Claude Code

claude mcp add --transport http --scope user web-api https://mcp.oxylabs.io/web-api-mcp --header 'Authorization: Bearer {api_key}'

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "web-api": {
      "url": "https://mcp.oxylabs.io/web-api-mcp",
      "headers": {
        "Authorization": "Bearer {api_key}"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "web-api": {
      "type": "http",
      "url": "https://mcp.oxylabs.io/web-api-mcp",
      "headers": {
        "Authorization": "Bearer {api_key}"
      }
    }
  }
}

Installed on your computer

Claude Code

claude mcp add --scope user web-api --env OXYLABS_WEB_API_KEY=your-value -- uvx oxylabs-web-api-mcp

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "web-api": {
      "command": "uvx",
      "args": [
        "oxylabs-web-api-mcp"
      ],
      "env": {
        "OXYLABS_WEB_API_KEY": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "web-api": {
      "command": "uvx",
      "args": [
        "oxylabs-web-api-mcp"
      ],
      "env": {
        "OXYLABS_WEB_API_KEY": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "web-api": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "oxylabs-web-api-mcp"
      ],
      "env": {
        "OXYLABS_WEB_API_KEY": "your-value"
      }
    }
  }
}

Values you fill in

  • OXYLABS_WEB_API_KEY secret required env
    Oxylabs Web API key, from a Web API instance in the Oxylabs dashboard.
  • Authorization secret required HTTP header
    Oxylabs Web API key, from a Web API instance in the Oxylabs dashboard.

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

Downloads per weeki
94/wk
Verified domain
✓ oxylabs.io
Connection
Computer or cloud
Transport
stdio, streamable-http
Latest versioni
0.3.1
Published to registryi
Nov 20, 2026
Code last changedi
Nov 20, 2026
Last checked
Nov 20, 2026
Maker
oxylabs
Packages
pypi: oxylabs-web-api-mcp
Website
oxylabs.io
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Connect over the internet in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatOpen WebUIRaycast

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Tool names and descriptions exactly as the server reported them on Nov 20, 2026. The maker wrote them, not us; we show them as plain text.

  • search

    Search the live web and return ranked organic results. Use it to search the web for information, above all anything where being out of date makes the answer wrong: current events, news, prices, availability, versions, rankings, "latest", "who is", competitor and market research,

  • search_companies

    Search for companies and return their profiles, best match first. Use it to look up a company by name, or to find companies matching a description (an industry, a product, a place, a size): market and competitor mapping, lead lists, funding research. Prefer it over `search` plus

  • scrape

    Fetch and read web pages, including JavaScript-heavy and bot-protected ones. Use whenever you have a URL and need what is on it. Prefer it over a built-in fetch: it goes through the anti-bot layer, so it returns the page where a plain HTTP fetch gets a block page, a consent wall

  • check_requests

    Collect requests the API is running in the background. Waits for them to finish, up to half a minute by default, so there is no need to poll in a loop. Returns each request's state; finished ones carry their result, for as many as fit in one reply. The rest come as summaries mark

  • read_result

    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 previ

  • list_scrapers

    List the scrape endpoints this API implements, or describe one of them. Not needed to read a URL — `scrape` does that for any site. Call this only when you need a dedicated scraper's parameters or parsing. The list is grouped by parser: `json_supported` endpoints have a dedicated

  • run_scraper

    Run a dedicated scrape endpoint with its own parameters. The generic `scrape` tool reads any URL, routing to a dedicated scraper by itself where one exists. Use this when at least one of these holds: you need parameters `scrape` lacks (pagination, sort order, store or delivery lo

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 20, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified against the domain oxylabs.io (the registry checks domain ownership)

  • ✓ Pass

    Still maintained

    Code last changed today

  • ✓ Pass

    Has a licence

    Uses MIT

  • ✓ Pass

    Endpoint responds

    Responded in 842 ms (HTTP 200)

  • – Not applicable

    Sign-in with OAuth

    No sign-in needed

  • ✓ Pass

    No hidden instructions in tool descriptions

    Read 7 tool descriptions and found no hidden instructions to the AI

Published vulnerabilities (OSV.dev)

No entries on OSV.dev for oxylabs-web-api-mcp@0.3.1

Checks only this package version, not every dependency · checked Nov 20, 2026

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/oxylabs-web-api-mcp.svg)](https://mcp.popnx.com/en/servers/oxylabs-web-api-mcp)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Search & AI memoryi

  • More stars than 97% of the other 6508 servers in this category
  • Published to the registry more recently than 99% of the other 6508 servers in this category
  • Basic checks equal to or better than 99% of the other 6508 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is Web API MCP safe?

It passed 5 of 5 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: Authorization, OXYLABS_WEB_API_KEY

Does it run on my computer or in the cloud?

Either way works: install it on your computer or connect to the cloud version.

Is it still maintained?

The GitHub repo last changed today, and the latest version (0.3.1) reached the registry today.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. It connects by URL, so apps that accept remote MCP servers work too, such as ChatGPT on the web (full MCP on Business and above; Pro read-only).

What can I use instead?

In the same category: OpenSEO, Exa, Microsoft Learn MCP, Docs, COTAL actions (cotal.ai)

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

OpenSEO

Keyword research, site audits, rank tracking and AI visibility for your AI agent.

by every-appWidely used★ 28.4KUpdated 6 days ago

Runs in the cloud✓ everyapp.com

Exa

Official Exa MCP for web search, content fetching, and multi-step research.

by exa-labsWidely used★ 5.2KUpdated today

Runs in the cloud✓ service owner · exa.aiTried by the PopNx team

Microsoft Learn MCP

Official Microsoft Learn MCP Server – real-time, trusted docs & code samples for AI and LLMs.

by MicrosoftDocsWidely used★ 2KUpdated 12 months ago

Runs in the cloud✓ service owner · microsoft.comTried by the PopNx team

Docs

Search and read Empryo's documentation. Read-only, no auth, no local access.

by proxysoulGrowing★ 1.6KUpdated 2 months ago

Runs in the cloud✓ empryo.com
Compared with similar ones
This one
Web API MCP
OpenSEOExaMicrosoft Learn MCPDocsCOTAL actions (cotal.ai)
Runs whereCloud or install on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to install
Needs a keyYesNoNoNoNoNo
Add with + in ClaudeNoYesYesYesNoNo
Basic checks5/55/52/44/44/44/4
LicenseMITMITMITCC-BY-4.0NOASSERTIONApache-2.0
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

Oxylabs Web API — MCP Server

mcp-name: io.oxylabs/web-api-mcp

This repository is a developer-focused, technical reference covering the official Model Context Protocol server for the Oxylabs Web API. It gives any MCP-capable agent live web access – search, scrape pages as Markdown or JSON, and call dedicated scrapers – through one MCP connection.

Remote MCPSelf-hosted MCP
Runs onOxylabs infrastructureYour machine or infrastructure
SetupAdd the server URL and your API key to your clientInstall the server (Python 3.10+ and uv), then configure your client
Updates and maintenanceManaged by OxylabsManaged by you
Best forThe quickest way to give a compatible agent access to Web APIFull control over the environment, or clients that can't connect to remote servers with a custom header

The tools and their behavior are the same on both options, and the sections on self-hosting cover everything you need to run the server yourself.

ToolWhat it does
searchSearch the live web, returns ranked organic results (title, outline snippets, URL)
search_companiesSearch companies by name or free-text description, returns company profiles best match first (industry, size, headquarters, funding, revenue, web traffic)
scrapeRead a URL, or a list of URLs, as Markdown by default, including JS-heavy and bot-protected pages. Ask for a screenshot, or pass json_prompt / json_schema to pull named fields off the page as JSON
list_scrapersList the scrape endpoints the API implements, grouped by parser support, or describe one's parameters
run_scraperRun a dedicated scrape endpoint with its own parameters, as content or as structured JSON; a list of urls or querys runs them all
check_requestsCollect requests the API is running in the background, waiting for them to finish
read_resultRead a page, or a search_companies list, too long for one reply in parts, by its request id

All seven are annotated readOnlyHint — nothing here writes anything, so clients can run them without prompting.

Requirements

  • An Oxylabs Web API key — in the Oxylabs dashboard, create a Web API instance, open it, and copy the API key shown at the top of the instance page.
  • For Remote MCP – an MCP client that supports remote (HTTP) MCP servers with custom headers, such as Claude Code, Codex, or Cursor.
  • For self-hosting – Python 3.10+ (built on FastMCP, installed with the package) and uv.

Connect to the Remote MCP server

The server is hosted and maintained by Oxylabs. There is nothing to install or update.

https://mcp.oxylabs.io/web-api-mcp

The server authenticates each request with your Web API key, sent as an Authorization: Bearer header. Set the key as an environment variable in the terminal where you run your client:

export OXYLABS_WEB_API_KEY="your_api_key_here"

Claude Code:

claude mcp add --transport http --scope user oxylabs-web-api \

https://mcp.oxylabs.io/web-api-mcp \ --header "Authorization: Bearer ${OXYLABS_WEB_API_KEY}"

Codex:

codex mcp add oxylabs-web-api \

--url https://mcp.oxylabs.io/web-api-mcp \ --bearer-token-env-var OXYLABS_WEB_API_KEY

Cursor — one click, then make the key visible to Cursor (below):

Cursor reads ${env:OXYLABS_WEB_API_KEY} from its own environment. On macOS, Cursor opened from the Dock or Spotlight does not see variables exported in your shell profile, so either start it from a terminal where the key is exported, or replace ${env:OXYLABS_WEB_API_KEY} with the key itself in Cursor Settings → Tools & MCP (or in ~/.cursor/mcp.json). If Cursor can't see the variable, it sends an empty key: the server still connects and lists its tools, but every call fails with an error saying the Web API key is missing.

Cursor (manual, ~/.cursor/mcp.json) and other clients supporting custom headers:

{

"mcpServers": { "oxylabs-web-api": { "url": "https://mcp.oxylabs.io/web-api-mcp", "headers": { "Authorization": "Bearer ${env:OXYLABS_WEB_API_KEY}" } } } }

Clients that only support OAuth sign-in for remote servers, such as custom connectors in the claude.ai web interface, can't send custom headers and can't connect to the Remote MCP server — use the self-hosted server with those clients instead.

Self-hosting

Run the server yourself when you want full control over where it runs and how it is configured. You install, host, and update it. The Remote MCP server and a self-hosted server use the same server name (oxylabs-web-api) in the examples, so if you switch from one to the other, remove the existing server from your client first.

Install
uv tool install git+https://github.com/oxylabs/web-api-mcp

That puts oxylabs-web-api-mcp on your PATH in its own environment. pipx install git+https://github.com/oxylabs/web-api-mcp does the same. Installing into a system Python usually fails — most are marked externally managed and refuse. To work on the server itself:

git clone https://github.com/oxylabs/web-api-mcp.git

cd web-api-mcp pip install -e .

server.json is the MCP registry manifest: it lists the PyPI package oxylabs-web-api-mcp and the Remote MCP server. A version tag publishes the package to PyPI and then server.json to the registry as io.oxylabs/web-api-mcp. The publish workflow refuses a release whose server.json versions differ from pyproject.toml, so bump them together. Keep the mcp-name: line at the top of this README: the registry looks for it in the package description on PyPI.

Run it locally (stdio)

Point your client at the installed oxylabs-web-api-mcp command. Keep your API key in an environment variable or a .env file rather than writing it into a client config.

Claude Code:

claude mcp add oxylabs-web-api \

--env OXYLABS_WEB_API_KEY='${OXYLABS_WEB_API_KEY}' \ -- oxylabs-web-api-mcp

Claude Desktop — create a .env file containing OXYLABS_WEB_API_KEY=your_api_key_here, keep it outside any shared or version-controlled folder, and point the server at it:

{

"mcpServers": { "oxylabs-web-api": { "command": "oxylabs-web-api-mcp", "env": { "OXYLABS_ENV_FILE": "/absolute/path/to/.env" } } } }

Cursor:

{

"mcpServers": { "oxylabs-web-api": { "command": "oxylabs-web-api-mcp", "env": { "OXYLABS_WEB_API_KEY": "${env:OXYLABS_WEB_API_KEY}" } } } }

For other clients that read a JSON config, use the same command entry and your client's own way of passing environment variables.

Run it as a shared server (HTTP)

The HTTP transport is for running one shared server for a team or for agents that can't spawn local processes.

export OXYLABS_WEB_API_KEY=your_api_key_here

export MCP_ALLOWED_HOSTS='mcp.internal.example.com,localhost:*' oxylabs-web-api-mcp --transport http --host 0.0.0.0 --port 8080

The endpoint is then http:// :8080/mcp.

Docker
export OXYLABS_WEB_API_KEY=your_api_key_here

docker build -t oxylabs-web-api-mcp . docker run --rm -p 8080:8080 \ -e OXYLABS_WEB_API_KEY \ -e MCP_ALLOWED_HOSTS='localhost:*,mcp.internal.example.com' \ oxylabs-web-api-mcp

Passing -e OXYLABS_WEB_API_KEY with no value makes Docker take the variable from your shell.

`MCP_ALLOWED_HOSTS` is not optional. The HTTP transport turns on DNS-rebinding

protection, so a server that doesn't declare its own hostname rejects every request

with a Host header it doesn't recognise (421 Misdirected Request). List the

hostname clients actually connect to. host:* matches any port on that host.

Configuration

These variables apply to a server you run yourself. The Remote MCP server's settings are managed by Oxylabs.

VariableDefaultPurpose
OXYLABS_WEB_API_KEY*(required on stdio)*Web API key, sent as Authorization: Bearer . Over HTTP a per-request Authorization: Bearer header takes precedence
OXYLABS_BASE_URLhttps://webapi.oxylabs.ioOverride the API base URL, e.g. to go through a proxy
OXYLABS_RETRIES2Retries on transient errors
OXYLABS_RATE_LIMIT*(off)*Cap what each API key spends through this server, e.g. 100/1h, 50/30m. Each item of a batch counts as one scrape
OXYLABS_MAX_INLINE_TOKENS10000Token budget for one reply; content beyond it is offloaded (stdio) or truncated (HTTP); company lists are shrunk and trimmed
OXYLABS_SPILL_DIRa per-user directory in the system temp dirWhere offloaded pages, company lists and screenshots are written (stdio only). Must be a directory you own
OXYLABS_SPILL1Set to 0 to keep everything inline even on stdio
MCP_TRANSPORTstdiostdio or http
HOST / PORT127.0.0.1 / 8080HTTP transport bind address
MCP_ALLOWED_HOSTSlocalhost:*,127.0.0.1:*Comma-separated Host allowlist (HTTP only)
MCP_ALLOWED_ORIGINS*(empty)*Comma-separated Origin allowlist (browser clients)

Copy .env.example to .env for local use. On stdio the server reads that .env from its working directory: any OXYLABS_* name not already set in the environment is filled from there, so a project that keeps its key in .env needs no launcher wrapper. Real environment variables always win, and only OXYLABS_* names are read. Point it elsewhere with OXYLABS_ENV_FILE=/path/to/.env.

The key is read at request time and is never written to disk or logged.

The skill ships with the server

Connecting the server is the whole install. The agent skill is bundled in the package and served as an MCP resource and a prompt, so a client that never adds the web-api-skills repo still gets the judgment for using these tools well — search to find and scrape to read, when JavaScript rendering earns its cost, what to do with an empty page, how to cite.

oxylabs://skill/web-apiThe skill itself, as Markdown
prompt web_researchTakes a question, hands the agent the task plus the skill

scripts/sync-skill.sh refreshes the bundled copy from the skills repo — the canonical copy lives there, and the two must not drift. Edit the skill in web-api-skills, never here: a daily workflow copies web-api-skills main over the bundled copy and opens a PR when that changes anything.

Fitting the client's context

Oversized content is measured in tokens, not characters: 40 000 characters of English is about 10 000 tokens, but 40 000 characters of Chinese is about 40 000, and Claude Code, Claude Desktop and Cursor all reject a tool result over 25 000. The estimate is script-aware for that reason. The budget is OXYLABS_MAX_INLINE_TOKENS (default 10 000), and a client that knows its own limit can override it per request with an X-MCP-Max-Tokens header — 0 opts out entirely. The budget covers the whole reply: every page of a result, every format it came in and parsed JSON all count, so a three-page search result fits as surely as a single page.

Sync first, queued only on a timeout

Every scrape goes to the synchronous endpoint first. If it times out — the API's own timeout, a gateway's 504, or no answer within 200 s — the same request is sent to the corresponding asynchronous endp

Only the beginning is shown; read the rest in the repo