Add Maxun to Your Agent

Give your AI agent the ability to scrape, crawl, search and extract web data in a couple of minutes. There are three options:

1. MCP server (recommended): adds Maxun's tools to any MCP client.
2. Agent skill: a skill for Claude Code or OpenClaw that runs your existing robots.
3. Docs in context: point a coding agent at the docs so it writes Maxun code for you.

Before you start

Get an API key from the Maxun dashboard under Settings → API Key. See API Key for details. Replace your_api_key_here below with your key.

Connect with MCP

The examples below use Maxun Cloud (https://app.maxun.dev/api/mcp). If you self-host Maxun, follow the self-hosted MCP setup instead.

Claude Code

Run this in your terminal:

claude mcp add --transport http maxun https://app.maxun.dev/api/mcp --header "x-api-key: your_api_key_here"

Add --scope user to make Maxun available in every project, or --scope project to share it with your team through .mcp.json. Run /mcp inside Claude Code to check the connection.

Cursor

Add Maxun to ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (this project):

{
  "mcpServers": {
    "maxun": {
      "url": "https://app.maxun.dev/api/mcp",
      "headers": {
        "x-api-key": "your_api_key_here"
      }
    }
  }
}

Open Cursor Settings → MCP and check that maxun shows a green dot.

VS Code

Add Maxun to .vscode/mcp.json in your workspace:

{
  "servers": {
    "maxun": {
      "type": "http",
      "url": "https://app.maxun.dev/api/mcp",
      "headers": {
        "x-api-key": "your_api_key_here"
      }
    }
  }
}

Then open Copilot Chat in Agent mode and select the Maxun tools.

Windsurf

Add Maxun to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "maxun": {
      "serverUrl": "https://app.maxun.dev/api/mcp",
      "headers": {
        "x-api-key": "your_api_key_here"
      }
    }
  }
}

Refresh the MCP servers in Windsurf's Cascade panel.

Claude Desktop

Open Settings → Developer → Edit Config and add Maxun to claude_desktop_config.json. Claude Desktop uses mcp-remote to connect, so Node.js must be installed.

{
  "mcpServers": {
    "maxun": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://app.maxun.dev/api/mcp",
        "--header",
        "x-api-key:your_api_key_here"
      ]
    }
  }
}

Restart Claude Desktop. The Maxun tools appear under the tools icon in the chat box.

Codex

Add Maxun to ~/.codex/config.toml:

[mcp_servers.maxun]
command = "npx"
args = ["-y", "mcp-remote", "https://app.maxun.dev/api/mcp", "--header", "x-api-key:your_api_key_here"]

Start a new Codex session to load the server.

Gemini CLI

Add Maxun to ~/.gemini/settings.json:

{
  "mcpServers": {
    "maxun": {
      "httpUrl": "https://app.maxun.dev/api/mcp",
      "headers": {
        "x-api-key": "your_api_key_here"
      }
    }
  }
}

Run /mcp in Gemini CLI to check the connection.

Other clients

Any MCP client that supports remote (Streamable HTTP) servers can connect with:

URL:     https://app.maxun.dev/api/mcp
Header:  x-api-key: your_api_key_here

If your client only supports local (stdio) servers, run the server through mcp-remote:

npx -y mcp-remote https://app.maxun.dev/api/mcp --header "x-api-key:your_api_key_here"

Work with a team's robots

Add an x-team-id header with your team ID to use a team's robots instead of your personal ones. See Use a team's robots.

Try it

Ask your agent something like:

• "Scrape https://news.ycombinator.com and list the top 10 stories as a table"
• "Search the web for the latest Maxun release notes and summarize them"
• "Crawl https://docs.maxun.dev and tell me which pages mention webhooks"
• "Get the name, price and rating of every product on https://example.com/shop"
• "Run my 'Competitor prices' robot and show me what changed"

See MCP Tools for every tool and its options.

Install an agent skill

Skills teach an agent how to run your existing Maxun robots with simple commands. Use them if you already build robots in the dashboard and want to run them from your agent.

Agent	Install	Guide
Claude Code	Download the skill to ~/.claude/skills/maxun	Claude Code skill
OpenClaw	clawhub install maxun	OpenClaw skill

All skills are open source in the maxun-skills repository.

Give your agent the docs

When a coding agent writes code that uses the Maxun SDK, CLI or API, give it the docs so it uses the current API:

• llms.txt: a short, curated map of the docs.
• llms-full.txt: every docs page in one file.
• Any page as Markdown: add .md to its URL, for example docs.maxun.dev/quickstart.md.

To make this permanent, add a note to your project's AGENTS.md, CLAUDE.md or .cursor/rules:

## Maxun
This project uses Maxun for web scraping and data extraction.
Before writing Maxun code, read https://docs.maxun.dev/llms.txt.
Fetch any docs page as Markdown by adding .md to its URL.
Read the API key from the MAXUN_API_KEY environment variable.

Or paste this prompt to have your agent add Maxun to your project:

Add Maxun to my project

ClaudeChatGPT

Add Maxun (https://maxun.dev) to this project so it can scrape, crawl, search and extract web data.

1. Read https://docs.maxun.dev/llms.txt to learn how Maxun works. Fetch any page as Markdown by adding .md to its URL.
2. Pick the official SDK for this project's language: maxun-sdk for Node.js/TypeScript, or maxun for Python.
3. Install it and read the API key from the MAXUN_API_KEY environment variable. Never hard-code the key. If .env.example exists, add MAXUN_API_KEY to it.
4. Add a small example that scrapes https://maxun.dev into Markdown and prints the result.
5. Tell me where to get an API key: https://app.maxun.dev, under Settings → API Key.

See LLM-ready docs for everything the docs offer AI tools.