Octoparse MCP Server
Octoparse MCP Server connects MCP-compatible AI clients to Octoparse so users can discover scraping templates, run cloud extraction tasks, manage existing tasks, and export structured data.
Hosted Server
Use the hosted Streamable HTTP endpoint:
https://mcp.octoparse.com
Configure this as an MCP server endpoint, not as a REST API tool.
Authentication
The hosted server supports two authentication patterns:
- OAuth: recommended when the MCP client can open a browser authorization flow.
- API key: useful for clients that can send custom HTTP headers.
For API key mode, send the key in the x-api-key header. Do not place real keys in source control, issue reports, screenshots, or shared logs.
Quick Start
Generic HTTP MCP configuration:
{
"mcpServers": {
"octoparse": {
"type": "http",
"url": "https://mcp.octoparse.com"
}
}
}
Claude Code:
claude mcp add --transport http octoparse https://mcp.octoparse.com
Gemini CLI example configuration:
{
"mcpServers": {
"octoparse": {
"httpUrl": "https://mcp.octoparse.com",
"oauth": {
"clientId": "Octoparse",
"enabled": true
}
}
}
}
After adding the server, complete authorization in the browser if your client prompts for OAuth.
More client examples are in Configuration.
Tools
| Tool | Purpose |
|---|---|
search_templates | Find Octoparse templates by keyword, template ID, or slug. |
execute_task | Validate parameters, create a cloud task, and start extraction. |
export_data | Export task results as JSON, CSV, Excel, HTML, or XML when data is ready. |
search_tasks | Search existing tasks in the authenticated account. |
start_or_stop_task | Start or stop an existing cloud task by task ID. |
redeem_coupon_code | Redeem a promotion, coupon, or resource code supplied by the user. |
See Tools for inputs, examples, and common failure cases.
Typical Workflow
search_templates -> execute_task -> export_data
Example user prompt:
Find a cloud-capable Octoparse template for Amazon product listings, run it for wireless earbuds, and export the result as CSV.
For an existing task, use:
search_tasks -> export_data
Scheduling, notifications, recurring jobs, and external automations are handled by the MCP client or another automation system. The MCP server exposes task and export tools; it does not provide a standalone scheduler.
Scope
Octoparse MCP Server can:
- Search the Octoparse template library.
- Run cloud-capable template tasks.
- Validate template parameters before execution.
- Export collected data when a task has data available.
- Search, start, and stop existing cloud tasks.
It does not:
- Run local-only desktop tasks through the hosted server.
- Create or edit arbitrary custom scraping workflows.
- Upload private templates.
- Provide billing or account administration tools.
- Schedule recurring runs by itself.
Common Limits
- Some templates are local-only and must be run in the Octoparse desktop app.
- Cloud execution depends on account permissions, available credits or quota, target-site availability, and template support.
- Long-running tasks may need follow-up calls. If data is still collecting or exporting, wait and call
export_dataagain. - Tool availability can be narrowed with
includeToolsorexcludeToolsURL parameters. See Overview.
Security
- Keep API keys and OAuth tokens out of Git, logs, screenshots, and public issues.
- Use OAuth when possible for interactive clients.
- Use
x-api-keyonly with clients that store headers securely. - Report vulnerabilities privately. See Security.
Documentation
Development
npm install
npm run build
npm test
For local environment variables, copy .env.example to .env and fill only values needed for your environment. Never commit .env.
Contributing
Contributions are welcome. Please read CONTRIBUTING.md before opening issues or pull requests.
License
MIT. See LICENSE.md.