ghcr.io/aas-ee/open-web-search:latest

Open-WebSearch

🇨🇳 中文 | 🇺🇸 English

open-websearch 提供 MCP 服务器、CLI 和本地守护进程，还可与技能引导的智能体工作流配合使用，实现无需 API 密钥的实时网络搜索和内容检索。

功能特性

• 多引擎结果网络搜索
• bing
• baidu
• linux.do 暂不支持
• csdn
• duckduckgo
• exa
• brave
• 掘金
• startpage
• sogou
• 支持 HTTP 代理配置以访问受限资源
• 无需 API 密钥或身份验证
• 返回包含标题、URL 和描述的结构化结果
• 可配置每次搜索的结果数量
• 可自定义默认搜索引擎
• 支持获取单篇文章内容
• csdn
• github（README 文件）
• 通用 HTTP(S) 页面 / Markdown 内容

常见配置：

# 为受限区域启用代理
USE_PROXY=true PROXY_URL=http://127.0.0.1:7890 npx open-websearch@latest

# 仅在目标网站存在证书链损坏时使用
FETCH_WEB_INSECURE_TLS=true npx open-websearch@latest

# 优先请求，Playwright可用时回退
SEARCH_MODE=auto npx open-websearch@latest

# 强制仅使用请求方式的Bing搜索
SEARCH_MODE=request npx open-websearch@latest

# 完整配置
DEFAULT_SEARCH_ENGINE=duckduckgo ENABLE_CORS=true USE_PROXY=true PROXY_URL=http://127.0.0.1:7890 PORT=8080 npx open-websearch@latest

浏览器增强型Bing回退需手动启用。已发布的包不再捆绑Playwright。可通过以下任一设置手动启用：

1. 完整本地Playwright安装：

npm install playwright
npx playwright install chromium
SEARCH_MODE=auto npx open-websearch@latest

2. 使用精简客户端重用已存在的浏览器二进制文件：

npm install playwright-core
PLAYWRIGHT_PACKAGE=playwright-core PLAYWRIGHT_EXECUTABLE_PATH=/path/to/chromium SEARCH_MODE=auto npx open-websearch@latest

3. 重用机器上其他位置已存在的Playwright包：

PLAYWRIGHT_MODULE_PATH=/absolute/path/to/node_modules/playwright SEARCH_MODE=playwright npx open-websearch@latest

4. 连接到已存在的远程浏览器：

npm install playwright-core
PLAYWRIGHT_PACKAGE=playwright-core PLAYWRIGHT_WS_ENDPOINT=ws://127.0.0.1:3000/ SEARCH_MODE=auto npx open-websearch@latest

5. 通过CDP重用本地Chrome/Chromium会话：

npm install playwright-core

# 首先启动带调试端口的Chrome/Chromium
chrome --remote-debugging-port=9222 --user-data-dir=/tmp/open-websearch-chrome

# 然后通过CDP连接
PLAYWRIGHT_PACKAGE=playwright-core PLAYWRIGHT_CDP_ENDPOINT=http://127.0.0.1:9222 SEARCH_MODE=auto npx open-websearch@latest

当需要重用自己已登录或已验证的浏览器会话时，这是最实用的设置。

Windows PowerShell示例：

npm install playwright-core

& "$env:LOCALAPPDATA\Google\Chrome\Application\chrome.exe" `
--remote-debugging-port=9222 `
--user-data-dir="$env:TEMP\open-websearch-chrome"

$env:PLAYWRIGHT_PACKAGE="playwright-core"
$env:PLAYWRIGHT_CDP_ENDPOINT="http://127.0.0.1:9222"
$env:SEARCH_MODE="auto"
npx open-websearch@latest

模式行为：

• request：仅使用基于请求的Bing抓取
• auto：优先尝试请求，仅当请求失败且手动配置的Playwright客户端+浏览器可用时才回退到Playwright
• playwright：强制使用Playwright，若配置的Playwright客户端或浏览器目标不可用则报错

注意事项：

• PLAYWRIGHT_MODULE_PATH 优先级高于 PLAYWRIGHT_PACKAGE
• PLAYWRIGHT_WS_ENDPOINT 优先级高于 PLAYWRIGHT_CDP_ENDPOINT
• 远程端点忽略 PLAYWRIGHT_EXECUTABLE_PATH 和本地代理启动标志
• 当Playwright可用时，被阻止的CSDN/知乎文章获取和通用网页获取也可使用浏览器获取的Cookie重试
• 没有Playwright时，fetchWebContent 仅使用请求方式。公共页面仍可正常工作，但需要浏览器Cookie或浏览器渲染HTML的页面可能失败

本地安装

1. 克隆或下载此仓库
2. 安装依赖：

npm install

这仅安装核心MCP服务器。浏览器回退仍是可选功能，需自行安装或连接Playwright客户端后启用。 3. 构建服务器：

npm run build

4. 将服务器添加到您的MCP配置中：

Docker 部署

使用 Docker Compose 快速部署：

docker-compose up -d

或直接使用 Docker：

docker run -d --name web-search -p 3000:3000 -e ENABLE_CORS=true -e CORS_ORIGIN=* ghcr.io/aas-ee/open-web-search:latest

环境变量配置：

然后在您的 MCP 客户端中进行配置：

{
"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"
}
}
}
}

使用指南

服务器提供六种工具：search、fetchLinuxDoArticle、fetchCsdnArticle、fetchGithubReadme、fetchJuejinArticle 和 fetchWebContent。

关于本地守护进程 HTTP API（serve、status、GET /health、POST /search、POST /fetch-*），请参见 docs/http-api.md。

search 工具使用方法

{
"query": string, // 搜索查询
"limit": number, // 可选：返回结果数量（默认：10）
"engines": string[], // 可选：使用的搜索引擎（bing,baidu,linuxdo,csdn,duckduckgo,exa,brave,juejin,startpage,sogou），默认使用运行时配置的引擎
"searchMode": string // 可选：request、auto 或 playwright（目前仅影响 Bing）
}

使用示例：

use_mcp_tool({
server_name: "web-search",
tool_name: "search",
arguments: {
query: "search content",
limit: 3, // 可选参数
engines: ["bing", "csdn", "duckduckgo", "exa", "brave", "juejin", "sogou"] // 可选参数，支持多引擎组合搜索
}
})

响应示例：

[
{
"title": "Example Search Result",
"url": "https://example.com",
"description": "Description text of the search result...",
"source": "Source",
"engine": "Engine used"
}
]

fetchCsdnArticle 工具使用方法

用于获取 CSDN 博客文章的完整内容。

{
"url": string // 使用 search 工具从 CSDN 搜索结果中获取的 URL
}

使用示例：

use_mcp_tool({
server_name: "web-search",
tool_name: "fetchCsdnArticle",
arguments: {
url: "https://blog.csdn.net/xxx/article/details/xxx"
}
})

响应示例：

[
{
"content": "Example search result"
}
]

fetchLinuxDoArticle 工具使用方法

用于获取 Linux.do 论坛文章的完整内容。

{
"url": string // 使用 search 工具从 linuxdo 搜索结果中获取的 URL
}

使用示例：

use_mcp_tool({
server_name: "web-search",
tool_name: "fetchLinuxDoArticle",
arguments: {
url: "https://xxxx.json"
}
})

响应示例：

[
{
"content": "Example search result"
}
]

fetchGithubReadme 工具使用方法

用于从 GitHub 仓库获取 README 内容。

{
"url": string // GitHub 仓库 URL（支持 HTTPS、SSH 格式）
}

使用示例：

use_mcp_tool({
server_name: "web-search",
tool_name: "fetchGithubReadme",
arguments: {
url: "https://github.com/Aas-ee/open-webSearch"
}
})

支持的 URL 格式：

• HTTPS：https://github.com/owner/repo
• 带 .git 的 HTTPS：https://github.com/owner/repo.git
• SSH：git@github.com:owner/repo.git
• 带参数的 URL：https://github.com/owner/repo?tab=readme

响应示例：

[
{
"content": " \n\n# Open-WebSearch MCP Server..."
}
]

fetchWebContent 工具使用方法

直接从公开的 HTTP(S) 链接获取内容，包括 Markdown 文件（.md）和普通网页。

fetchJuejinArticle 工具使用方法

用于获取掘金文章的完整内容。

{
"url": string // 搜索结果中的掘金文章 URL
}

使用示例：

use_mcp_tool({
server_name: "web-search",
tool_name: "fetchJuejinArticle",
arguments: {
url: "https://juejin.cn/post/7520959840199360563"
}
})

支持的 URL 格式：

• https://juejin.cn/post/{article_id}

响应示例：

[
{
"content": "🚀 开源 AI 联网搜索工具：Open-WebSearch MCP 全新升级，支持多引擎 + 流式响应..."
}
]

使用限制

由于本工具通过抓取多引擎搜索结果工作，请注意以下重要限制：

1. 速率限制：

• 短时间内过多搜索可能导致所用引擎暂时阻止请求
• 建议：
• 保持合理的搜索频率
• 谨慎使用 limit 参数
• 必要时在搜索之间添加延迟

2. 结果准确性：

• 依赖于对应引擎的 HTML 结构，引擎更新时可能失效
• 部分结果可能缺少描述等元数据
• 复杂搜索运算符可能无法按预期工作

3. ***条款：

• 本工具仅用于个人用途
• 请遵守对应引擎的服务条款
• 根据实际使用场景实施适当的速率限制

4. 搜索引擎配置：

• 默认搜索引擎可通过 DEFAULT_SEARCH_ENGINE 环境变量设置
• 支持的引擎：bing、duckduckgo、exa、brave、baidu、csdn、juejin、startpage、sogou
• 搜索特定网站时使用默认引擎

5. 代理配置：

• 特定地区无法访问某些搜索引擎时，可配置 HTTP 代理
• 通过环境变量 USE_PROXY=true 启用代理
• 通过 PROXY_URL 配置代理服务器地址
• 对于 *** fake-ip / TUN 配置，通过 FAKE_IP_CIDRS 配置合成 DNS 范围（例如 198.18.0.0/15）

贡献指南

欢迎提交问题报告和功能改进建议！

贡献者指南

如果您想 Fork 本仓库并发布自己的 Docker 镜像，需要进行以下配置：

GitHub 密钥配置

要启用 Docker 镜像的自动构建和发布，请在 GitHub 仓库设置（Settings → Secrets and variables → Actions）中添加以下密钥：

必填密钥：

• GITHUB_TOKEN：由 GitHub 自动提供（无需设置）

可选密钥（适用于阿里云 ACR）：

• ACR_REGISTRY：您的阿里云容器镜像服务 URL（例如 registry.cn-hangzhou.aliyuncs.com）
• ACR_USERNAME：您的阿里云 ACR 用户名
• ACR_PASSWORD：您的阿里云 ACR 密码
• ACR_IMAGE_NAME：您在 ACR 中的镜像名称（例如 your-namespace/open-web-search）

CI/CD 工作流

仓库包含一个 GitHub Actions 工作流（.github/workflows/docker.yml），可自动执行以下操作：

1. 触发条件：

• 推送到 main 分支
• 推送版本标签（v*）
• 手动触发工作流

2. 构建并推送到：

• GitHub 容器注册表（ghcr.io）- 始终启用
• 阿里云容器镜像服务 - 仅在配置 ACR 密钥时启用

3. 镜像标签：

• ghcr.io/your-username/open-web-search:latest
• your-acr-address/your-image-name:latest（如果配置了 ACR）

Fork 和发布步骤：

1. Fork 仓库到您的 GitHub 账户
2. 配置密钥（如果需要发布到 ACR）：

• 在您的 Fork 仓库中，进入 Settings → Secrets and variables → Actions
• 添加上述列出的 ACR 相关密钥

3. 推送更改到 main 分支或创建版本标签
4. GitHub Actions 将自动构建并推送您的 Docker 镜像
5. 使用您的镜像，更新 Docker 命令：

docker run -d --name web-search -p 3000:3000 -e ENABLE_CORS=true -e CORS_ORIGIN=* ghcr.io/your-username/open-web-search:latest

注意事项：

• 如果不配置 ACR 密钥，工作流将仅发布到 GitHub 容器注册表
• 确保您的 GitHub 仓库已启用 Actions
• 工作流将使用您的 GitHub 用户名（转换为小写）作为 GHCR 镜像名称

星标历史

如果您觉得本项目有帮助，请考虑给它一个 ⭐ 星标！