{
  "markdown": "# Octoparse MCP Server\n\n[![Octoparse](https://img.shields.io/badge/Octoparse-Official%20Website-blue?logo=google-chrome)](https://www.octoparse.com/)\n[![Docs](https://img.shields.io/badge/Docs-MCP%20Guide-green)](https://openapi.octoparse.com/octoparse-mcp-guide.html)\n![MCP](https://img.shields.io/badge/MCP-Compatible-purple)\n\n[English](README.md) | [日本語](README-ja.md)\n\nOctoparse MCP Server connects MCP-compatible AI clients to Octoparse so users can discover scraping templates, create cloud tasks from Octoparse preset templates, manage existing tasks, and export structured data.\n\n## Hosted Server\n\nUse the hosted Streamable HTTP endpoint:\n\n```text\nhttps://mcp.octoparse.com\n```\n\nConfigure this as an MCP server endpoint, not as a REST API tool.\n\n## Authentication\n\nThe hosted server officially supports both OAuth and API key authentication:\n\n- OAuth: the default option when the MCP client can open a browser authorization flow.\n- API key: an optional authentication method for clients that can send custom HTTP headers.\n\nFor 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.\n\n## Quick Start\n\nGeneric HTTP MCP configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"octoparse\": {\n      \"type\": \"http\",\n      \"url\": \"https://mcp.octoparse.com\"\n    }\n  }\n}\n```\n\nClaude OAuth / default authentication:\n\n```bash\nclaude mcp add --transport http octoparse https://mcp.octoparse.com\n```\n\nClaude with API key:\n\n```bash\nclaude mcp add --transport http octoparse https://mcp.octoparse.com --header \"x-api-key: YOUR_API_KEY\"\n```\n\nCodex CLI:\n\n```bash\ncodex mcp add octoparse --url https://mcp.octoparse.com\n```\n\nGemini CLI example configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"octoparse\": {\n      \"httpUrl\": \"https://mcp.octoparse.com\",\n      \"oauth\": {\n        \"clientId\": \"Octoparse\",\n        \"enabled\": true\n      }\n    }\n  }\n}\n```\n\nAfter adding the server, complete authorization in the browser if your client prompts for OAuth.\n\nMore client examples are in [Configuration](docs/Configuration.md).\n\n## Tools\n\n| Tool | Purpose |\n| --- | --- |\n| `search_templates` | Find Octoparse templates by keyword, template ID, or slug. |\n| `execute_task` | Validate parameters, create a cloud task from an Octoparse preset template, and start extraction. |\n| `export_data` | Export task results as JSON, CSV, Excel, HTML, or XML when data is ready. |\n| `search_tasks` | Search existing tasks in the authenticated account. |\n| `start_or_stop_task` | Start or stop an existing cloud task by task ID. |\n| `redeem_coupon_code` | Redeem a promotion, coupon, or resource code supplied by the user. |\n\nSee [Tools](docs/Tools.md) for inputs, examples, and common failure cases.\n\n## Typical Workflow\n\n```text\nsearch_templates -> execute_task -> export_data\n```\n\nExample user prompt:\n\n```text\nFind a cloud-capable Octoparse template for Amazon product listings, run it for wireless earbuds, and export the result as CSV.\n```\n\nFor an existing task, use:\n\n```text\nsearch_tasks -> export_data\n```\n\nScheduling, 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.\n\n## Scope\n\nOctoparse MCP Server can:\n\n- Search the Octoparse template library.\n- Create and run cloud-capable tasks from Octoparse preset templates.\n- Validate template parameters before execution.\n- Export collected data when a task has data available.\n- Search, start, stop, monitor, and export existing cloud-supported tasks, including existing cloud-supported custom tasks.\n\nIt does not:\n\n- Run local-only desktop tasks through the hosted server.\n- Create fully custom scraping tasks.\n- Create or edit custom task configuration details such as custom fields, pagination rules, loop logic, browser workflow, or extraction steps.\n- Upload private templates.\n- Provide billing or account administration tools.\n- Schedule recurring runs by itself.\n\n## Common Limits\n\n- Some templates are local-only and must be run in the Octoparse desktop app.\n- Cloud execution depends on account permissions, available credits or quota, target-site availability, and template support.\n- Long-running tasks may need follow-up calls. If data is still collecting or exporting, wait and call `export_data` again.\n- Tool availability can be narrowed with `includeTools` or `excludeTools` URL parameters. See [Overview](docs/Overview.md).\n\n## Security\n\n- Keep API keys and OAuth tokens out of Git, logs, screenshots, and public issues.\n- Use OAuth when possible for interactive clients.\n- Use `x-api-key` only with clients that store headers securely.\n- Report vulnerabilities privately. See [Security](SECURITY.md).\n\n## Documentation\n\n- [Overview](docs/Overview.md)\n- [Configuration](docs/Configuration.md)\n- [Tools](docs/Tools.md)\n- [Troubleshooting](docs/Troubleshooting.md)\n- [Octoparse API Docs](https://openapi.octoparse.com/en-US)\n- [Help Center](https://helpcenter.octoparse.com)\n- [Available on Smithery](https://smithery.ai/servers/octoparse/octoparse-mcp-server)\n\n## Development\n\n```bash\nnpm install\nnpm run build\nnpm test\n```\n\nFor local environment variables, copy `.env.example` to `.env` and fill only values needed for your environment. Never commit `.env`.\n\n## Contributing\n\nContributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening issues or pull requests.\n\n## License\n\nMIT. See [LICENSE.md](LICENSE.md).\n",
  "bytes": 5511,
  "sha": "ca7038bff47cb9411f6f8a26521e201a9a30fc4dc778ab4e166c3dd2a0520519",
  "repo_slug": "octoparse/octoparse-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_com_octoparse_octoparse_mcp_f4ce7848/readme"
}