search2ai

环境要求

• Node.js 运行环境（需能执行 npm / npx 命令）
• 至少一个搜索服务的 API Key，如 SEARCH1API_KEY、TAVILY_KEY
• 若走 MCP 方式，需要 Claude Desktop / Cursor / Claude Code 等支持 MCP 的客户端

安装与启动步骤

1. 1安装 search2ai 库

   以库方式接入，零部署成本。在项目目录执行安装，之后可从 search2ai/core 导入。

   npm i search2ai

   复制

2. 2配置搜索服务密钥

   自带 key（BYO key）。只配置你要用的 provider，用环境变量传入密钥。

   export SEARCH1API_KEY=your_key
   export TAVILY_KEY=your_key

   复制

3. 3编写搜索调用代码

   用 createGateway 初始化网关，调用 search 获取结果，返回体含 provider 与 warnings。

   import { createGateway } from 'search2ai/core';
   
   const gateway = createGateway({
     providers: {
       search1api: { apiKey: process.env.SEARCH1API_KEY! },
       tavily: { apiKey: process.env.TAVILY_KEY! },
     },
   });
   
   const { provider, results, warnings } = await gateway.search({ query: 'hono cloudflare workers', max_results: 5 });

   复制

4. 4本地启动 MCP 服务

   MCP 方式同样零部署，通过 npx 直接拉起，对外提供 search、news、crawl 三个工具。

   npx -y search2ai mcp

   复制

5. 5接入 MCP 客户端

   把配置写入 Claude Desktop / Cursor / Claude Code 的 MCP 配置，密钥放在 env 里。

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

   复制

6. 6查看完整配置模板

   项目根目录的 .env.template 列出了所有可用环境变量，按需补充 provider 与缓存等配置。

关键配置

如何确认成功

调用 gateway.search 能返回 provider 与 results 即接入成功；MCP 方式则在客户端工具列表看到 search、news、crawl。

常见问题

注意事项

• 只配置你实际要用的 provider；未指定 SEARCH_SERVICE 时，已配置的 provider 按默认优先级组成 fallback 链。
• 以上 *_KEY 变量也接受 *_API_KEY 写法，例如 TAVILY_KEY 可写成 TAVILY_API_KEY。
• SearXNG 需要自行开启 JSON 输出格式，并配置 SEARXNG_BASE_URL。
• 完整环境变量与模板参见仓库根目录的 .env.template。