Inspired by curl, provides web request functionality for fetching content from websites and making REST API requests with custom methods, headers, and bodies.
Provides Google Custom Search functionality, allowing web searches with configurable result limits through Google's search API, requiring an API key and Custom Search Engine ID.
Leverages Puppeteer for robust web scraping capabilities, including resource blocking, content extraction, and headless browsing of websites.
Google Custom Search API
Google Custom Search API is free with usage limits (e.g., 100 queries per day for free, with additional queries requiring payment). For full details on quotas, pricing, and restrictions, see the official documentation.
Web-curl
Developed by Rayss
🚀 Open Source Project
🛠️ Built with Node.js & TypeScript (Node.js v18+ required)
🎬 Demo Video
📚 Table of Contents
- Overview
- Features
- Architecture
- Installation
- Usage
- Configuration
- Examples
- Troubleshooting
- Tips & Best Practices
- Contributing & Issues
- License & Attribution
📝 Overview
Web-curl is a powerful tool for fetching and extracting text content from web pages and APIs. Use it as a standalone CLI or as an MCP (Model Context Protocol) server. Web-curl leverages Puppeteer for robust web scraping and supports advanced features such as resource blocking, custom headers, authentication, and Google Custom Search.
✨ Features
- 🔎 Retrieve text content from any website.
- 🚫 Block unnecessary resources (images, stylesheets, fonts) for faster loading.
- ⏱️ Set navigation timeouts and content extraction limits.
- 💾 Output results to stdout or save to a file.
- 🖥️ Use as a CLI tool or as an MCP server.
- 🌐 Make REST API requests with custom methods, headers, and bodies.
- 🔍 Integrate Google Custom Search (requires API key and CX).
- 🤖 Smart command parsing (auto-detects URLs and search queries).
- 🛡️ Detailed error logging and robust error handling.
🏗️ Architecture
- CLI & MCP Server:
src/index.ts
Implements both the CLI entry point and the MCP server, exposing tools likefetch_webpage
,fetch_api
,google_search
, andsmart_command
. - Web Scraping: Uses Puppeteer for headless browsing, resource blocking, and content extraction.
- REST Client:
src/rest-client.ts
Provides a flexible HTTP client for API requests, used by both CLI and MCP tools. - Configuration: Managed via CLI options, environment variables, and tool arguments.
⚙️ MCP Server Configuration Example
To integrate web-curl as an MCP server, add the following configuration to your mcp_settings.json
:
🔑 How to Obtain Google API Key and CX
- Get a Google API Key:
- Go to Google Cloud Console.
- Create/select a project, then go to APIs & Services > Credentials.
- Click Create Credentials > API key and copy it.
- Get a Custom Search Engine (CX) ID:
- Go to Google Custom Search Engine.
- Create/select a search engine, then copy the Search engine ID (CX).
- Enable Custom Search API:
- In Google Cloud Console, go to APIs & Services > Library.
- Search for Custom Search API and enable it.
Replace YOUR_GOOGLE_API_KEY
and YOUR_CX_ID
in the config above.
🛠️ Installation
For more details, see the Puppeteer troubleshooting guide.
Command Line Options
--timeout <ms>
: Set navigation timeout (default: 60000)--no-block-resources
: Disable blocking of images, stylesheets, and fonts-o <file>
: Output result to specified file
MCP Server Usage
Web-curl can be run as an MCP server for integration with Roo Code or other MCP-compatible platforms.
Exposed Tools
- fetch_webpage: Retrieve text content from a web page
- fetch_api: Make REST API requests
- google_search: Search the web using Google Custom Search API
- smart_command: Accepts natural language commands and auto-routes to the appropriate tool
Running as MCP Server
The server communicates via stdio and exposes tools as defined in src/index.ts
.
MCP Tool Example (fetch_webpage)
Google Search Integration
Set the following environment variables for Google Custom Search:
APIKEY_GOOGLE_SEARCH
: Your Google API keyCX_GOOGLE_SEARCH
: Your Custom Search Engine ID
🧩 Configuration
- Resource Blocking: Block images, stylesheets, and fonts for faster scraping.
- Timeouts: Set navigation and API request timeouts.
- Custom Headers: Pass custom HTTP headers for advanced scenarios.
- Authentication: Supports HTTP Basic Auth via username/password.
- Environment Variables: Used for Google Search API integration.
💡 Examples
🛠️ Troubleshooting
- Timeout Errors: Increase the
timeout
parameter if requests are timing out. - Blocked Content: If content is missing, try disabling resource blocking or adjusting
resourceTypesToBlock
. - Google Search Fails: Ensure
APIKEY_GOOGLE_SEARCH
andCX_GOOGLE_SEARCH
are set in your environment. - Binary/Unknown Content: Non-text responses are base64-encoded.
- Error Logs: Check the
logs/error-log.txt
file for detailed error messages.
🧠 Tips & Best Practices
- Use resource blocking for faster and lighter scraping unless you need images or styles.
- For large pages, use
maxLength
andstartIndex
to paginate content extraction. - Always validate your tool arguments to avoid errors.
- Secure your API keys and sensitive data using environment variables.
- Review the MCP tool schemas in
src/index.ts
for all available options.
🤝 Contributing & Issues
Contributions are welcome! If you want to contribute, fork this repository and submit a pull request.
If you find any issues or have suggestions, please open an issue on the repository page.
📄 License & Attribution
This project was developed by Rayss.
For questions, improvements, or contributions, please contact the author or open an issue in the repository.
Note: Google Search API is free with usage limits. For details, see: Google Custom Search API Overview
This server cannot be installed
A powerful tool for fetching and extracting text content from web pages and APIs, supporting web scraping, REST API requests, and Google Custom Search integration.
Related MCP Servers
- AsecurityAlicenseAqualityProvides functionality to fetch web content in various formats, including HTML, JSON, plain text, and Markdown.Last updated -4125,855353TypeScriptMIT License
- AsecurityAlicenseAqualityA server that provides web scraping and intelligent content searching capabilities using the Firecrawl API, enabling AI agents to extract structured data from websites and perform content searches.Last updated -52TypeScriptMIT License
- -securityFlicense-qualityProvides functionality to fetch web content in various formats, including HTML, JSON, plain text, and Markdown.Last updated -125,8551
Oxylabs MCP Serverofficial
AsecurityAlicenseAqualityA scraper tool that leverages the Oxylabs Web Scraper API to fetch and process web content with flexible options for parsing and rendering pages, enabling efficient content extraction from complex websites.Last updated -232PythonMIT License