项目简介
brave-search-server 是一个实现了 Model Context Protocol (MCP) 的服务器,专注于提供强大的搜索功能。它利用 Brave Search API,并内置代理支持,以便在网络环境受限或API访问不稳定的情况下也能可靠运行。此服务器旨在作为大型语言模型 (LLM) 的上下文信息提供者,使其能够通过工具调用执行网络和本地搜索。
主要功能点
- 网络搜索: 使用 Brave Search API 执行全面的网络搜索,适用于查找各种在线信息。
- 本地搜索: 提供基于 Brave Local Search API 的本地商业信息搜索,例如餐馆、商店等。
- 代理支持: 内置代理配置,允许在需要通过代理才能访问外部API的环境中使用。
- 速率限制: 实施了请求速率限制,以符合 Brave Search API 的使用条款 (每秒1次请求,每月15000次请求)。
- Claude 客户端集成: 特别优化了与 Claude 桌面客户端的集成,可以无缝连接使用。
安装步骤
- 环境准备: 确保已安装 Node.js (推荐最新 LTS 版本) 和 npm 包管理器。
- 安装依赖: 在项目根目录下打开终端,运行以下命令安装必要的依赖包:
npm install @modelcontextprotocol/sdk node-fetch@2 https-proxy-agent @types/node-fetch - 配置代理 (可选): 如果需要通过代理访问 Brave Search API,请编辑 'src/index.ts' 文件,修改 'PROXY_URL' 变量的值为您的代理服务器地址。默认配置为 'http://127.0.0.1:7890'。
- 构建项目: 在项目根目录下运行以下命令编译 TypeScript 代码:
npm run build
服务器配置 (MCP 客户端)
要将 brave-search-server 集成到 MCP 客户端(例如 Claude),您需要提供以下服务器配置信息。将以下 JSON 配置添加到 MCP 客户端的服务器配置文件中:
{ "brave-search-server": { "command": "node", "args": [ "/path/to/your/brave-search-server/build/index.js" ], "env": { "BRAVE_API_KEY": "YOUR-API-KEY" } } }
配置参数说明:
- '"brave-search-server"': 服务器的名称,用于在客户端配置中标识该服务器。您可以自定义此名称。
- '"command": "node"': 指定启动服务器的命令为 'node',即使用 Node.js 运行时环境。
- '"args": [...]"': 命令参数数组。
- '"/path/to/your/brave-search-server/build/index.js"': 指向编译后的服务器入口文件 'index.js' 的路径。请务必将 '/path/to/your/brave-search-server' 替换为 brave-search-server 项目在您本地文件系统中的实际路径。
- '"env": {...}': 环境变量配置。
- '"BRAVE_API_KEY": "YOUR-API-KEY"': Brave Search API 的密钥。请将 '"YOUR-API-KEY"' 替换为您从 Brave 获得的 API 密钥。 您需要在运行服务器的环境中设置 'BRAVE_API_KEY' 环境变量。
基本使用方法
配置完成后,MCP 客户端(如 Claude)将能够通过 brave-search-server 提供的工具进行搜索。
- 网络搜索工具: 'brave_web_search'
- 描述: 使用 Brave Search API 执行网络搜索。
- 参数 (JSON 格式):
{ "query": "您的搜索关键词", "count": 10, // 可选,结果数量 (1-20, 默认 10) "offset": 0 // 可选,分页偏移量 (最大 9, 默认 0) }
- 本地搜索工具: 'brave_local_search'
- 描述: 使用 Brave Local Search API 搜索本地商业信息。
- 参数 (JSON 格式):
{ "query": "本地搜索关键词 (例如: '附近的咖啡馆')", "count": 5 // 可选,结果数量 (1-20, 默认 5) }
在 MCP 客户端中,您可以指示 LLM 调用这些工具,并传递相应的参数来执行搜索操作。服务器会将搜索结果以文本形式返回给客户端。
信息
分类
网页与API