web search the internet
bash
Basic usage
npx open-websearch@latest
With environment variables (Linux/macOS)
DEFAULT_SEARCH_ENGINE=duckduckgo ENABLE_CORS=true npx open-websearch@latest
Windows PowerShell
$env:DEFAULT_SEARCH_ENGINE="duckduckgo"; $env:ENABLE_CORS="true"; npx open-websearch@latest
Windows CMD
set MODE=stdio && set DEFAULT_SEARCH_ENGINE=duckduckgo && npx open-websearch@latest
Cross-platform (requires cross-env, Used for local development)
npm install -g open-websearch
npx cross-env DEFAULT_SEARCH_ENGINE=duckduckgo ENABLE_CORS=true open-websearch
`
Environment Variables:
| Variable | Default | Options | Description |
|----------|-------------------------|---------|-------------|
| ENABLE_CORS | false | true, false | Enable CORS |
| CORS_ORIGIN | * | Any valid origin | CORS origin configuration |
| DEFAULT_SEARCH_ENGINE | bing | bing, duckduckgo, exa, brave, baidu, csdn, juejin | Default search engine |
| USE_PROXY | false | true, false | Enable HTTP proxy |
| PROXY_URL | http://127.0.0.1:7890 | Any valid URL | Proxy server URL |
| MODE | both | both, http, stdio | Server mode: both HTTP+STDIO, HTTP only, or STDIO only |
| PORT | 3000 | 1-65535 | Server port |
| ALLOWED_SEARCH_ENGINES | empty (all available) | Comma-separated engine names | Limit which search engines can be used; if the default engine is not in this list, the first allowed engine becomes the default |
Common configurations:
`bash
Enable proxy for restricted regions
USE_PROXY=true PROXY_URL=http://127.0.0.1:7890 npx open-websearch@latest
Full configuration
DEFAULT_SEARCH_ENGINE=duckduckgo ENABLE_CORS=true USE_PROXY=true PROXY_URL=http://127.0.0.1:7890 PORT=8080 npx open-websearch@latest
`
$3
1. Clone or download this repository
2. Install dependencies:
`bash
npm install
`
3. Build the server:
`bash
npm run build
`
4. Add the server to your MCP configuration:
Cherry Studio:
`json
{
"mcpServers": {
"web-search": {
"name": "Web Search MCP",
"type": "streamableHttp",
"description": "Multi-engine web search with article fetching",
"isActive": true,
"baseUrl": "http://localhost:3000/mcp"
}
}
}
`
VSCode (Claude Dev Extension):
`json
{
"mcpServers": {
"web-search": {
"transport": {
"type": "streamableHttp",
"url": "http://localhost:3000/mcp"
}
},
"web-search-sse": {
"transport": {
"type": "sse",
"url": "http://localhost:3000/sse"
}
}
}
}
`
Claude Desktop:
`json
{
"mcpServers": {
"web-search": {
"transport": {
"type": "streamableHttp",
"url": "http://localhost:3000/mcp"
}
},
"web-search-sse": {
"transport": {
"type": "sse",
"url": "http://localhost:3000/sse"
}
}
}
}
`
NPX Command Line Configuration:
`json
{
"mcpServers": {
"web-search": {
"args": [
"open-websearch@latest"
],
"command": "npx",
"env": {
"MODE": "stdio",
"DEFAULT_SEARCH_ENGINE": "duckduckgo",
"ALLOWED_SEARCH_ENGINES": "duckduckgo,bing,exa"
}
}
}
}
`
Local STDIO Configuration for Cherry Studio (Windows):
`json
{
"mcpServers": {
"open-websearch-local": {
"command": "node",
"args": ["C:/path/to/your/project/build/index.js"],
"env": {
"MODE": "stdio",
"DEFAULT_SEARCH_ENGINE": "duckduckgo",
"ALLOWED_SEARCH_ENGINES": "duckduckgo,bing,exa"
}
}
}
}
`
$3
Quick deployment using Docker Compose:
`bash
docker-compose up -d
`
Or use Docker directly:
`bash
docker run -d --name web-search -p 3000:3000 -e ENABLE_CORS=true -e CORS_ORIGIN=* ghcr.io/aas-ee/open-web-search:latest
`
Environment variable configuration:
| Variable | Default | Options | Description |
|----------|-------------------------|---------|-------------|
| ENABLE_CORS | false | true, false | Enable CORS |
| CORS_ORIGIN | * | Any valid origin | CORS origin configuration |
| DEFAULT_SEARCH_ENGINE | bing | bing, duckduckgo, exa, brave | Default search engine |
| USE_PROXY | false | true, false | Enable HTTP proxy |
| PROXY_URL | http://127.0.0.1:7890 | Any valid URL | Proxy server URL |
| PORT | 3000 | 1-65535 | Server port |
Then configure in your MCP client:
`json
{
"mcpServers": {
"web-search": {
"name": "Web Search MCP",
"type": "streamableHttp",
"description": "Multi-engine web search with article fetching",
"isActive": true,
"baseUrl": "http://localhost:3000/mcp"
},
"web-search-sse": {
"transport": {
"name": "Web Search MCP",
"type": "sse",
"description": "Multi-engine web search with article fetching",
"isActive": true,
"url": "http://localhost:3000/sse"
}
}
}
}
`
Usage Guide
The server provides four tools: search, fetchLinuxDoArticle, fetchCsdnArticle, and fetchGithubReadme.
$3
`typescript
{
"query": string, // Search query
"limit": number, // Optional: Number of results to return (default: 10)
"engines": string[] // Optional: Engines to use (bing,baidu,linuxdo,csdn,duckduckgo,exa,brave,juejin) default bing
}
`
Usage example:
`typescript
use_mcp_tool({
server_name: "web-search",
tool_name: "search",
arguments: {
query: "search content",
limit: 3, // Optional parameter
engines: ["bing", "csdn", "duckduckgo", "exa", "brave", "juejin"] // Optional parameter, supports multi-engine combined search
}
})
`
Response example:
`json
[
{
"title": "Example Search Result",
"url": "https://example.com",
"description": "Description text of the search result...",
"source": "Source",
"engine": "Engine used"
}
]
`
$3
Used to fetch complete content of CSDN blog articles.
`typescript
{
"url": string // URL from CSDN search results using the search tool
}
`
Usage example:
`typescript
use_mcp_tool({
server_name: "web-search",
tool_name: "fetchCsdnArticle",
arguments: {
url: "https://blog.csdn.net/xxx/article/details/xxx"
}
})
`
Response example:
`json
[
{
"content": "Example search result"
}
]
`
$3
Used to fetch complete content of Linux.do forum articles.
`typescript
{
"url": string // URL from linuxdo search results using the search tool
}
`
Usage example:
`typescript
use_mcp_tool({
server_name: "web-search",
tool_name: "fetchLinuxDoArticle",
arguments: {
url: "https://xxxx.json"
}
})
`
Response example:
`json
[
{
"content": "Example search result"
}
]
`
$3
Used to fetch README content from GitHub repositories.
`typescript
{
"url": string // GitHub repository URL (supports HTTPS, SSH formats)
}
`
Usage example:
`typescript
use_mcp_tool({
server_name: "web-search",
tool_name: "fetchGithubReadme",
arguments: {
url: "https://github.com/Aas-ee/open-webSearch"
}
})
`
Supported URL formats:
- HTTPS: https://github.com/owner/repo
- HTTPS with .git: https://github.com/owner/repo.git
- SSH: git@github.com:owner/repo.git
- URLs with parameters: https://github.com/owner/repo?tab=readme
Response example:
`json
[
{
"content": "\n\n# Open-WebSearch MCP Server..."
}
]
`
$3
Used to fetch complete content of Juejin articles.
`typescript
{
"url": string // Juejin article URL from search results
}
`
Usage example:
`typescript
use_mcp_tool({
server_name: "web-search",
tool_name: "fetchJuejinArticle",
arguments: {
url: "https://juejin.cn/post/7520959840199360563"
}
})
`
Supported URL format:
- https://juejin.cn/post/{article_id}
Response example:
`json
[
{
"content": "🚀 开源 AI 联网搜索工具：Open-WebSearch MCP 全新升级，支持多引擎 + 流式响应..."
}
]
`
Usage Limitations
Since this tool works by scraping multi-engine search results, please note the following important limitations:
1. Rate Limiting:
- Too many searches in a short time may cause the used engines to temporarily block requests
- Recommendations:
- Maintain reasonable search frequency
- Use the limit parameter judiciously
- Add delays between searches when necessary
2. Result Accuracy:
- Depends on the HTML structure of corresponding engines, may fail when engines update
- Some results may lack metadata like descriptions
- Complex search operators may not work as expected
3. Legal Terms:
- This tool is for personal use only
- Please comply with the terms of service of corresponding engines
- Implement appropriate rate limiting based on your actual use case
4. Search Engine Configuration:
- Default search engine can be set via the DEFAULT_SEARCH_ENGINE environment variable
- Supported engines: bing, duckduckgo, exa, brave
- The default engine is used when searching specific websites
5. Proxy Configuration:
- HTTP proxy can be configured when certain search engines are unavailable in specific regions
- Enable proxy with environment variable USE_PROXY=true
- Configure proxy server address with PROXY_URL
Contributing
Welcome to submit issue reports and feature improvement suggestions!
$3
If you want to fork this repository and publish your own Docker image, you need to make the following configurations:
#### GitHub Secrets Configuration
To enable automatic Docker image building and publishing, please add the following secrets in your GitHub repository settings (Settings → Secrets and variables → Actions):
Required Secrets:
- GITHUB_TOKEN: Automatically provided by GitHub (no setup needed)
Optional Secrets (for Alibaba Cloud ACR):
- ACR_REGISTRY: Your Alibaba Cloud Container Registry URL (e.g., registry.cn-hangzhou.aliyuncs.com)
- ACR_USERNAME: Your Alibaba Cloud ACR username
- ACR_PASSWORD: Your Alibaba Cloud ACR password
- ACR_IMAGE_NAME: Your image name in ACR (e.g., your-namespace/open-web-search)
#### CI/CD Workflow
The repository includes a GitHub Actions workflow (.github/workflows/docker.yml) that automatically:
1. Trigger Conditions:
- Push to main branch
- Push version tags (v*)
- Manual workflow trigger
2. Build and Push to:
- GitHub Container Registry (ghcr.io) - always enabled
- Alibaba Cloud Container Registry - only enabled when ACR secrets are configured
3. Image Tags:
- ghcr.io/your-username/open-web-search:latest
- your-acr-address/your-image-name:latest (if ACR is configured)
#### Fork and Publish Steps:
1. Fork the repository to your GitHub account
2. Configure secrets (if you need ACR publishing):
- Go to Settings → Secrets and variables → Actions in your forked repository
- Add the ACR-related secrets listed above
3. Push changes to the main branch or create version tags
4. GitHub Actions will automatically build and push your Docker image
5. Use your image, update the Docker command:
`bash
docker run -d --name web-search -p 3000:3000 -e ENABLE_CORS=true -e CORS_ORIGIN=* ghcr.io/your-username/open-web-search:latest
``
#### Notes:
- If you don't configure ACR secrets, the workflow will only publish to GitHub Container Registry
- Make sure your GitHub repository has Actions enabled
- The workflow will use your GitHub username (converted to lowercase) as the GHCR image name
Star History
If you find this project helpful, please consider giving it a ⭐ Star!
