使用说明
项目简介
brave-search-mcp 是一个基于 Model Context Protocol (MCP) 标准构建的服务器,旨在为大型语言模型 (LLM) 提供网页搜索功能。它充当 LLM 与 Brave Search API 之间的桥梁,允许 LLM 通过调用 'web_search' 工具来检索最新的网络信息,从而增强 LLM 在需要实时信息场景下的应用能力。
主要功能点
- 网页搜索工具 (web_search): 提供根据用户查询在互联网上搜索信息的功能。
- 基于 MCP 协议: 遵循 MCP 协议标准,易于与兼容 MCP 协议的 LLM 客户端集成。
- 可配置的 Brave Search API 密钥: 允许用户配置自己的 Brave Search API 密钥,以便使用该服务。
安装步骤
- 克隆仓库:
git clone https://github.com/apridachin/brave-search-mcp.git cd brave-search-mcp - 安装依赖 (如果需要): 虽然仓库中没有明确的依赖安装步骤,但根据代码推测,可能需要安装 'uv', 'httpx', 'jsonschema', 'python-dotenv', 'async-lru' 和 'modelcontextprotocol' 库。 您可以使用 'pip' 或 'uv' 进行安装。 例如使用 'uv':
uv pip install httpx jsonschema python-dotenv async-lru modelcontextprotocol - 配置环境变量:
- 在项目根目录下创建 '.env' 文件。
- 在 '.env' 文件中设置 'BRAVE_API_KEY' 环境变量,替换为您的 Brave Search API 密钥。 您可能还需要根据需要配置 'LOG_LEVEL' 和 'BRAVE_URL' 环境变量。
BRAVE_API_KEY=YOUR_BRAVE_API_KEY LOG_LEVEL=INFO BRAVE_URL=https://api.search.brave.com/
服务器配置
要将 'brave-search-mcp' 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要提供服务器的启动命令和参数。 以下是一个示例配置,您可以将其添加到 MCP 客户端的配置文件中。
{ "servers": { "brave-search-mcp": { "command": "uv", "args": [ "--directory", "path_to_project", // 请替换为 brave-search-mcp 项目的实际路径 "run", "src/brave_search_mcp/server.py" // 指向服务器启动脚本 ], "env": { "BRAVE_API_KEY": "YOUR API KEY" // 您的 Brave API 密钥,也可以在 .env 文件中配置 } } } }
配置参数说明:
- '"servers"': 定义 MCP 服务器配置的顶级键。
- '"brave-search-mcp"': 服务器的名称,客户端用此名称来标识和调用该服务器。
- '"command": "uv"': 启动服务器的命令。 这里使用 'uv' (假设已安装并添加到环境变量中),您也可以根据您的环境使用 'python' 或其他 Python 运行器。
- '"args"': 传递给启动命令的参数列表。
- '"--directory", "path_to_project"': 指定项目目录的路径。 请将 '"path_to_project"' 替换为 'brave-search-mcp' 项目在您本地文件系统上的实际绝对路径。
- '"run"': 'uv run' 命令用于运行 Python 脚本。
- '"src/brave_search_mcp/server.py"': 指定要运行的服务器主脚本的路径。 请确保路径正确。
- '"env"': 设置服务器运行所需的环境变量。
- '"BRAVE_API_KEY": "YOUR API KEY"': Brave Search API 密钥。 请将 '"YOUR API KEY"' 替换为您的实际 API 密钥。 您也可以选择在 '.env' 文件中配置,如果配置在 '.env' 文件中,这里可以省略 '"env"' 部分。
注意: MCP 客户端的具体配置文件位置和格式可能有所不同,请参考您使用的 MCP 客户端的官方文档进行配置。 例如,Claude Desktop 的配置文件路径已在仓库的 README.md 中给出。
基本使用方法
- 确保已按照安装步骤配置好服务器并启动。
- 在兼容 MCP 协议的 LLM 客户端中配置并连接到 'brave-search-mcp' 服务器。
- 使用 LLM 客户端提供的界面或方式,调用 'web_search' 工具,并提供必要的参数,例如 'query' (搜索关键词)。
示例工具调用 (JSON 格式,在 MCP 客户端中发起):
{ "tool_calls": [ { "tool_name": "web_search", "tool_arguments": { "query": "最新的AI技术发展", "count": "5", "country": "CN", "search_lang": "zh-hans" } } ] }
LLM 客户端会将上述 JSON 请求发送到 'brave-search-mcp' 服务器,服务器会调用 Brave Search API 进行搜索,并将搜索结果返回给 LLM 客户端。 LLM 客户端可以根据返回的结果进行后续处理,例如生成摘要、回答问题等。
信息
分类
网页与API