Search1API MCP 服务器

中文文档

一个使用 Search1API 提供搜索和抓取功能的模型上下文协议 (MCP) 服务器。

前提条件

• Node.js >= 18.0.0
• 有效的 Search1API API 密钥（请参阅下面的设置指南，了解如何获取和配置）

安装（独立/通用）

1. 克隆存储库：

   git clone https://github.com/fatwang2/search1api-mcp.git
   cd search1api-mcp
   

2. 配置 API 密钥： 在构建之前，您需要提供您的 Search1API 密钥。 请参阅下面的设置指南部分，了解不同的方法（例如，使用 .env 文件或环境变量）。

3. 安装依赖项并构建：

   npm install
   npm run build
   

   注意：如果使用项目的 .env 文件方法获取 API 密钥，请确保在此步骤之前该文件存在。

用法（独立/通用）

确保您的 API 密钥已配置（请参阅设置指南）。

启动服务器：

npm start

然后，服务器将准备好接受来自 MCP 客户端的连接。

设置指南

1. 获取 Search1API 密钥

1. 在 Search1API 注册
2. 从您的仪表板获取您的 API 密钥。

2. 配置 API 密钥

您需要使您的 API 密钥可供服务器使用。 选择以下一种方法：

方法 A：项目 .env 文件（推荐用于独立或 LibreChat）

如果与当前版本的 LibreChat 集成，则需要使用此方法（请参阅下面的特定部分）。

1. 在 search1api-mcp 项目根目录中，创建一个名为 .env 的文件：

   # 在 search1api-mcp 目录中
   echo "SEARCH1API_KEY=your_api_key_here" > .env
   

2. 将 your_api_key_here 替换为您的实际密钥。
3. 确保在运行 npm install && npm run build 之前此文件存在。

方法 B：环境变量（仅限独立）

在启动服务器之前，设置 SEARCH1API_KEY 环境变量。

export SEARCH1API_KEY="your_api_key_here"
npm start

方法 C：MCP 客户端配置（高级）

某些 MCP 客户端允许直接在其配置中指定环境变量。 这对于像 Cursor、VS Code 扩展等客户端很有用。

{
  "mcpServers": {
    "search1api": {
      "command": "npx",
      "args": [
        "-y",
        "search1api-mcp"
      ],
      "env": {
        "SEARCH1API_KEY": "YOUR_SEARCH1API_KEY"
      }
    }
  }
}

LibreChat 用户注意事项： 由于 LibreChat 当前的限制，方法 A（项目 .env 文件）是必需的方法。 有关完整说明，请参阅下面的专用集成部分。

与 LibreChat 集成 (Docker)

本节详细介绍了通过 Docker 与 LibreChat 集成所需的步骤。

概述：

1. 将此服务器的存储库克隆到 LibreChat docker-compose.yml 可以访问的位置。
2. 使用此服务器目录中的项目 .env 文件方法配置所需的 API 密钥。
3. 构建此服务器。
4. 通过编辑 librechat.yaml 告诉 LibreChat 如何运行此服务器。
5. 确保构建的服务器代码通过 Docker 卷绑定在 LibreChat 容器内可用。
6. 重启 LibreChat。

分步说明：

1. 克隆存储库： 导航到主机上管理 LibreChat 外部服务的目录（通常与您的 docker-compose.yml 位于同一位置）。 常见的位置是专用的 mcp-server 目录。

   # 示例：导航到 docker-compose.yml 所在的位置，然后进入 mcp-server
   cd /path/to/your/librechat/setup/mcp-server
   git clone https://github.com/fatwang2/search1api-mcp.git
   

2. 导航到服务器目录：

   cd search1api-mcp
   

3. 配置 API 密钥（项目 .env 文件方法 - LibreChat 必需）：

   # 创建 .env 文件
   echo "SEARCH1API_KEY=your_api_key_here" > .env
   # 重要提示：将 'your_api_key_here' 替换为您的实际 Search1API 密钥
   

4. 安装依赖项并构建： 此步骤将服务器代码编译到 build 目录中。

   npm install
   npm run build
   

5. 配置 librechat.yaml： 编辑您的主 librechat.yaml 文件，以告诉 LibreChat 如何执行此 MCP 服务器。 在 mcp_servers 下添加一个条目：

   # 在您的主 librechat.yaml 中
   mcp_servers:
     # 您也可以在此处添加其他 MCP 服务器
     search1api:
       # 可选：LibreChat UI 中服务器的显示名称
       # name: Search1API Tools
   
       # Command 告诉 LibreChat 使用 'node'
       command: node
   
       # Args 指定 'node' 要运行的脚本 *在容器内*
       args:
         - /app/mcp-server/search1api-mcp/build/index.js
   

   • args 路径 (/app/...) 是 在 LibreChat API 容器内部访问构建的服务器的位置（感谢下一步中的卷绑定）。

6. 配置 Docker 卷绑定： 编辑您的 docker-compose.yml（或更可能是您的 docker-compose.override.yml），以将 search1api-mcp 目录从您的主机映射到 LibreChat API 容器中。 找到 api: 服务的 volumes: 部分：

   # 在您的 docker-compose.yml 或 docker-compose.override.yml 中
   services:
     api:
       # ... 其他服务配置 ...
       volumes:
         # ... 其他卷可能存在于此 ...
   
         # 添加此卷绑定：
         - ./mcp-server/search1api-mcp:/app/mcp-server/search1api-mcp
   

   • 主机路径 (./mcp-server/search1api-mcp): 这是您的主机上 相对于 docker-compose.yml 文件所在位置的路径。 如果您在其他地方克隆了存储库，请进行调整。
   • 容器路径 (:/app/mcp-server/search1api-mcp): 这是 容器内部 的路径。 它必须匹配 librechat.yaml args 路径中使用的目录结构。

7. 重启 LibreChat： 通过重建（如果您修改了 docker-compose.yml）并重启您的 LibreChat 堆栈来应用更改。

   docker compose down && docker compose up -d --build
   # 或者：docker compose restart api (如果仅更改了 librechat.yaml)
   

现在，Search1API 服务器应该可以在 LibreChat 中作为工具提供程序使用。

特性

• 网页搜索功能
• 新闻搜索功能
• 网页内容提取
• 网站站点地图提取
• 使用 DeepSeek R1 进行深度思考和复杂问题解决
• 与 Claude Desktop、Cursor、Windsurf、Cline 和其他 MCP 客户端无缝集成

工具

1. 搜索工具

• 名称: search
• 描述: 使用 Search1API 搜索网络
• 参数:
  • query (必需): 自然语言的搜索查询。 为了获得更好的结果，请具体而简洁
  • max_results (可选, 默认: 10): 返回的结果数
  • search_service (可选, 默认: "google"): 要使用的搜索服务 (google, bing, duckduckgo, yahoo, x, reddit, github, youtube, arxiv, wechat, bilibili, imdb, wikipedia)
  • crawl_results (可选, 默认: 0): 要抓取以获取完整网页内容的结果数
  • include_sites (可选): 要包含在搜索中的站点列表
  • exclude_sites (可选): 要从搜索中排除的站点列表
  • time_range (可选): 搜索结果的时间范围 ("day", "month", "year")

2. 新闻工具

• 名称: news
• 描述: 使用 Search1API 搜索新闻文章
• 参数:
  • query (必需): 自然语言的搜索查询。 为了获得更好的结果，请具体而简洁
  • max_results (可选, 默认: 10): 返回的结果数
  • search_service (可选, 默认: "bing"): 要使用的搜索服务 (google, bing, duckduckgo, yahoo, hackernews)
  • crawl_results (可选, 默认: 0): 要抓取以获取完整网页内容的结果数
  • include_sites (可选): 要包含在搜索中的站点列表
  • exclude_sites (可选): 要从搜索中排除的站点列表
  • time_range (可选): 搜索结果的时间范围 ("day", "month", "year")

3. 抓取工具

• 名称: crawl
• 描述: 使用 Search1API 从 URL 提取内容
• 参数:
  • url (必需): 要抓取的 URL

4. 站点地图工具

• 名称: sitemap
• 描述: 从 URL 获取所有相关链接
• 参数:
  • url (必需): 获取站点地图的 URL

5. 推理工具

• 名称: reasoning
• 描述: 一种使用快速 deepseek r1 模型和网络搜索能力进行深度思考和复杂问题解决的工具（您可以在 search1api 网站中更改为任何其他模型，但速度无法保证）
• 参数:
  • content (必需): 需要深度思考的问题或难题

6. 趋势工具

• 名称: trending
• 描述: 从热门平台获取热门话题
• 参数:
  • search_service (必需): 指定要从中获取热门话题的平台 (github, hackernews)
  • max_results (可选, 默认: 10): 要返回的最大热门项目数

版本历史

• v0.2.0: 添加了对 LibreChat 集成的后备 .env 支持，并更新了依赖项。
• v0.1.8: 添加了 X(Twitter) 和 Reddit 搜索服务
• v0.1.7: 添加了 GitHub 和 Hacker News 的趋势工具
• v0.1.6: 添加了 Wikipedia 搜索服务
• v0.1.5: 添加了新的搜索参数（include_sites、exclude_sites、time_range）和新的搜索服务（arxiv、wechat、bilibili、imdb）
• v0.1.4: 添加了带有 deepseek r1 的推理工具，并更新了 Cursor 和 Windsurf 配置指南
• v0.1.3: 添加了新闻搜索功能
• v0.1.2: 添加了站点地图功能
• v0.1.1: 添加了网络抓取功能
• v0.1.0: 初始版本，具有搜索功能

许可证

该项目已获得 MIT 许可证的许可 - 有关详细信息，请参阅 LICENSE 文件。