> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Octoparse MCP Server

> Overview and quick start for the Octoparse MCP Server.

Connect Octoparse's web-scraping platform to any MCP-compatible AI agent. Search templates, run cloud tasks, and retrieve data — all from natural language.

Works with pre-built Octoparse templates and cloud-supported tasks.

## Prerequisites

<Steps>
  <Step title="An Octoparse account">
    Any Octoparse account can connect. Free and Basic users receive 2,000 free records per week for MCP extraction — no upgrade required to get started.
  </Step>

  <Step title="An MCP-compatible client">
    Such as ChatGPT, Codex, Claude, Claude Code, OpenClaw, Cursor, VS Code (GitHub Copilot), or Antigravity.
  </Step>
</Steps>

***

## Scope & limitations

<Columns cols={2}>
  <Card title="✅ Can do">
    * Search pre-built scraping templates
    * Create a new cloud task from a preset template and run it
    * Trigger and monitor cloud-supported task runs
    * Export collected data (JSON / CSV)
    * List and search existing tasks
    * Start or stop a running task
    * Redeem a coupon code
  </Card>

  <Card title="❌ Cannot do">
    * Run local-only tasks (desktop client required)
    * Create fully custom tasks or edit task configuration details such as fields, pagination, loops, or browser workflow
    * Upload custom scraping templates
    * Access account settings or billing
    * Scrape without a preset template
  </Card>
</Columns>

<Note>
  MCP can create and run new cloud tasks from Octoparse preset templates. It cannot create fully custom scraping workflows or edit custom task configuration details. If you need a custom workflow, create it in Octoparse first, then use MCP to run, monitor, stop, or export it.
</Note>

***

## Quick start

### Server URL

```text Server URL theme={null}
https://mcp.octoparse.com
```

### Authentication methods

<Columns cols={2}>
  <Card title="Path A: OAuth 2.1" icon="lock-keyhole">
    Browser-based login. Recommended for most users. No API key needed — just sign in to Octoparse when prompted.
  </Card>

  <Card title="Path B: API key" icon="key">
    Direct API key authentication. Best for automated or headless environments like Claude Code, Codex CLI, VS Code, TRAE, and OpenClaw.

    Get your key from your [Octoparse account center](https://www.octoparse.com/console/account-center/api-keys).
  </Card>
</Columns>

## Supported clients

Choose your MCP client below and follow the setup steps.

<div className="mb-8 grid grid-cols-2 gap-2 sm:grid-cols-4">
  <a href="#chatgpt" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://op-official-us-1251101074.cos.na-siliconvalley.myqcloud.com/mcp/chatgpt.svg" alt="" className="h-6 w-6 shrink-0" />

    <span>ChatGPT</span>
  </a>

  <a href="#codex" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://mintcdn.com/octoparse/JjtZ5xTfKo3caPro/images/mcp/codex.svg?fit=max&auto=format&n=JjtZ5xTfKo3caPro&q=85&s=56e3220fb8fd0f8dd7aa931b0836e0cf" alt="" className="h-6 w-6 shrink-0" width="36" height="36" data-path="images/mcp/codex.svg" />

    <span>Codex</span>
  </a>

  <a href="#claude" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://op-official-us-1251101074.cos.na-siliconvalley.myqcloud.com/mcp/claude.svg" alt="" className="h-6 w-6 shrink-0" />

    <span>Claude</span>
  </a>

  <a href="#claude-code" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://mintcdn.com/octoparse/JjtZ5xTfKo3caPro/images/mcp/claude-code.svg?fit=max&auto=format&n=JjtZ5xTfKo3caPro&q=85&s=41a82256b2cd0af12c8c70542c817228" alt="" className="h-6 w-6 shrink-0" width="36" height="36" data-path="images/mcp/claude-code.svg" />

    <span>Claude Code</span>
  </a>

  <a href="#openclaw" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://op-official-us-1251101074.cos.na-siliconvalley.myqcloud.com/mcp/openclaw.svg" alt="" className="h-6 w-6 shrink-0" />

    <span>OpenClaw</span>
  </a>

  <a href="#cursor" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://op-official-us-1251101074.cos.na-siliconvalley.myqcloud.com/mcp/cursor.svg" alt="" className="h-6 w-6 shrink-0" />

    <span>Cursor</span>
  </a>

  <a href="#vs-code" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://op-official-us-1251101074.cos.na-siliconvalley.myqcloud.com/mcp/vscode.svg" alt="" className="h-6 w-6 shrink-0" />

    <span>VS Code</span>
  </a>

  <a href="#antigravity" className="flex min-h-14 items-center gap-3 rounded-lg border border-gray-200 px-3 py-2 text-sm font-medium text-gray-900 no-underline transition-colors hover:border-gray-300 hover:bg-gray-50 dark:border-gray-700 dark:text-gray-100 dark:hover:border-gray-600 dark:hover:bg-gray-900/40">
    <img src="https://mintcdn.com/octoparse/JjtZ5xTfKo3caPro/images/mcp/antigravity.svg?fit=max&auto=format&n=JjtZ5xTfKo3caPro&q=85&s=fabe46bcd843c81a23b16f27bc031b23" alt="" className="h-6 w-6 shrink-0" width="36" height="36" data-path="images/mcp/antigravity.svg" />

    <span>Antigravity</span>
  </a>
</div>

<AccordionGroup>
  <Accordion id="chatgpt" title="ChatGPT">
    <Steps>
      <Step title="Open Customization settings">
        Click your profile avatar and choose **Customize ChatGPT**.
      </Step>

      <Step title="Enable Developer Mode">
        Go to **Apps → Advanced Settings** and turn on **Developer Mode (Beta)**.
      </Step>

      <Step title="Create the Octoparse app">
        Click **Create app**. Set Name to `Octoparse`, MCP URL to `https://mcp.octoparse.com`, leave OAuth Client ID and Secret blank, confirm the acknowledgement, then create the app.
      </Step>

      <Step title="Authorize via OAuth">
        ChatGPT redirects to Octoparse. Sign in and click **Allow**.
      </Step>
    </Steps>

    [See full setup guide](https://helpcenter.octoparse.com/en/articles/13444709-how-to-integrate-octoparse-with-chatgpt-via-mcp-step-by-step)
  </Accordion>

  <Accordion id="codex" title="Codex">
    <Note>Codex CLI and the Codex IDE extension share the same MCP configuration (`~/.codex/config.toml`). Set it up once and it works in both.</Note>

    **Path A: OAuth**

    <Steps>
      <Step title="Add the server">
        ```bash theme={null}
        codex mcp add octoparse --url https://mcp.octoparse.com
        ```
      </Step>

      <Step title="Authorize via OAuth">
        ```bash theme={null}
        codex mcp login octoparse
        ```

        A browser window opens. Sign in to Octoparse and click **Allow**.
      </Step>
    </Steps>

    ***

    **Path B: API Key**

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

    ```toml theme={null}
        [mcp_servers.octoparse]
        url = "https://mcp.octoparse.com"
        http_headers = { "x-api-key" = "YOUR_API_KEY" }
    ```
  </Accordion>

  <Accordion id="claude" title="Claude">
    **Path A: OAuth**

    <Steps>
      <Step title="Open Settings → Connectors">
        In the Claude sidebar, go to **Settings → Connectors**.
      </Step>

      <Step title="Add the server URL">
        Click **Add Connector** and enter `https://mcp.octoparse.com`.
      </Step>

      <Step title="Authorize via OAuth">
        Click **Connect**. A browser window opens. Sign in and click **Allow**.
      </Step>
    </Steps>

    [See full setup guide](https://helpcenter.octoparse.com/en/articles/14001844-how-to-integrate-octoparse-with-claude-via-mcp-step-by-step)
  </Accordion>

  <Accordion id="claude-code" title="Claude Code">
    <Note>Servers added with `claude mcp add` are shared across the Claude Code CLI, desktop app, and IDE extensions (VS Code / JetBrains). Set it up once and it works everywhere.</Note>

    **Path A: OAuth**

    <Steps>
      <Step title="Add the server">
        ```bash theme={null}
        claude mcp add --transport http octoparse https://mcp.octoparse.com
        ```
      </Step>

      <Step title="Authorize via OAuth">
        Start Claude Code and run `/mcp`, then select **octoparse** to authenticate. A browser window opens — sign in to Octoparse and click **Allow**.
      </Step>
    </Steps>

    ***

    **Path B: API Key**

    ```bash theme={null}
    claude mcp add --transport http octoparse https://mcp.octoparse.com --header "x-api-key: YOUR_API_KEY"
    ```
  </Accordion>

  <Accordion id="openclaw" title="OpenClaw">
    **Path A: OAuth**

    <Steps>
      <Step title="Install OpenClaw">
        Install OpenClaw, then run the onboard command.
      </Step>

      <Step title="Register the MCP server">
        Set the Octoparse MCP server and verify the configuration.
      </Step>

      <Step title="Restart the Gateway">
        Restart the Gateway to apply the configuration.
      </Step>

      <Step title="Authorize via OAuth">
        Your first Octoparse tool call opens a browser for OAuth. Sign in and click **Allow**.
      </Step>
    </Steps>

    ***

    **Path B: API Key**

    ```bash theme={null}
        mcporter config add octoparse https://mcp.octoparse.com
        mcporter config set octoparse header.x-api-key "YOUR_API_KEY"
    ```

    Then add to OpenClaw config:

    ```json theme={null}
        {
          "mcp": {
            "servers": {
              "octoparse": {
                "command": "mcporter",
                "args": ["run", "stdio", "--server", "octoparse"]
              }
            }
          }
        }
    ```
  </Accordion>

  <Accordion id="cursor" title="Cursor">
    **Path A: OAuth**

    <Steps>
      <Step title="Open Cursor Settings">
        Open Cursor and click the settings icon in the top-right corner.
      </Step>

      <Step title="Go to Tools & MCP">
        In the left sidebar, select **Tools & MCP**.
      </Step>

      <Step title="Add a custom MCP server">
        Click **Add Custom MCP**. Cursor opens the MCP configuration file. Add `https://mcp.octoparse.com` and save.
      </Step>
    </Steps>

    [See full setup guide](https://helpcenter.octoparse.com/en/articles/14013893-how-to-integrate-octoparse-with-cursor-via-mcp-step-by-step)

    ***

    **Path B: API Key**

    Add to `~/.cursor/mcp.json`:

    ```json theme={null}
        {
          "mcpServers": {
            "octoparse": {
              "type": "http",
              "url": "https://mcp.octoparse.com",
              "headers": {
                "x-api-key": "YOUR_API_KEY"
              }
            }
          }
        }
    ```
  </Accordion>

  <Accordion id="vs-code" title="VS Code">
    <Info>Requires an active **GitHub Copilot** subscription.</Info>

    **Path A: OAuth**

    Add to `.vscode/mcp.json`:

    ```json theme={null}
        {
          "servers": {
            "octoparse": {
              "type": "http",
              "url": "https://mcp.octoparse.com"
            }
          }
        }
    ```

    [See full setup guide](https://helpcenter.octoparse.com/en/articles/14004033-how-to-integrate-octoparse-with-vs-code-via-mcp-step-by-step)

    ***

    **Path B: API Key**

    ```json theme={null}
        {
          "servers": {
            "octoparse": {
              "type": "http",
              "url": "https://mcp.octoparse.com",
              "headers": {
                "x-api-key": "YOUR_API_KEY"
              }
            }
          }
        }
    ```
  </Accordion>

  <Accordion id="antigravity" title="Antigravity">
    <Note>The Antigravity IDE and Antigravity CLI share the same MCP configuration (`~/.gemini/config/mcp_config.json`). Set it up once and it works in both. In the IDE, you can also open it from the agent panel: **MCP Servers → View raw config**.</Note>

    **Path A: OAuth**

    Add to `~/.gemini/config/mcp_config.json`:

    ```json theme={null}
        {
          "mcpServers": {
            "octoparse": {
              "serverUrl": "https://mcp.octoparse.com"
            }
          }
        }
    ```

    Refresh the MCP server list. Your first Octoparse tool call opens a browser for OAuth — sign in and click **Allow**.

    ***

    **Path B: API Key**

    ```json theme={null}
        {
          "mcpServers": {
            "octoparse": {
              "serverUrl": "https://mcp.octoparse.com",
              "headers": {
                "x-api-key": "YOUR_API_KEY"
              }
            }
          }
        }
    ```
  </Accordion>
</AccordionGroup>