使用说明

项目简介

本项目是 Model Context Protocol (MCP) 服务器的参考实现仓库,旨在演示如何构建 MCP 服务器并集成各种工具和服务,以增强大型语言模型 (LLM) 的能力。 本仓库包含 'brave-search' 服务器,它利用 Brave 搜索 API 提供强大的网络和本地搜索功能,使 LLM 能够访问最新的在线信息和本地商业数据。

主要功能点

  • 网络搜索: 通过 Brave Search API 执行广泛的网络搜索,帮助 LLM 获取最新的信息、新闻、文章和各种在线内容,适用于需要通用信息收集和了解最新动态的场景。
  • 本地搜索: 利用 Brave Local Search API 搜索本地商家和地点信息,能够返回详细的商家信息,例如名称、地址、评分、电话和营业时间等,特别适用于处理用户 “附近” 或指定位置的查询。

安装步骤

  1. 环境准备: 确保你的计算机上已安装 Node.js 和 npm (Node 包管理器)。
  2. 克隆仓库: 使用 Git 命令克隆本仓库到本地:
    git clone https://github.com/luoshui-coder/MCP.git
  3. 进入目录: 通过 'cd' 命令进入 'brave-search' 服务器的目录:
    cd MCP/src/brave-search
  4. 安装依赖: 运行 'npm install' 命令安装项目所需的依赖包:
    npm install
  5. 配置 API 密钥: 你需要申请 Brave Search API 密钥,并将其设置为环境变量 'BRAVE_API_KEY'。请查阅 Brave Search API 文档获取密钥并设置环境变量。

服务器配置

为了让 MCP 客户端 (例如 Claude) 连接到 'brave-search' 服务器,你需要配置客户端的 MCP 服务器设置。 以下是一个配置示例,你需要根据你的实际情况进行调整。

{
  "mcpServers": {
    "brave-search": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-brave-search"],
      "env": {
        "BRAVE_API_KEY": "<YOUR_BRAVE_API_KEY>"
      }
    }
  }
}

配置参数说明:

  • 'server name': 'brave-search' - 服务器名称,在 MCP 客户端配置中,服务器名称需要与此处定义的名称保持一致。
  • 'command': 'npx' - 启动服务器的命令。 'npx' 是 Node.js 的包执行器,用于运行安装在项目依赖中的 npm 包。
  • 'args': '["-y", "@modelcontextprotocol/server-brave-search"]' - 传递给启动命令的参数。
    • '-y': 标志,用于指示 'npx' 自动安装 '@modelcontextprotocol/server-brave-search' 包及其依赖 (如果尚未安装)。
    • '@modelcontextprotocol/server-brave-search': 指定要执行的 npm 包名称,这是 'brave-search' 服务器的包名。
  • 'env': '{"BRAVE_API_KEY": "<YOUR_BRAVE_API_KEY>"}' - 环境变量配置。
    • 'BRAVE_API_KEY': 'brave-search' 服务器需要 Brave Search API 密钥才能正常工作。 '<YOUR_BRAVE_API_KEY>' 需要替换为你自己申请的 Brave Search API 密钥。

基本使用方法

  1. 启动服务器: 配置完成后,在 'brave-search' 服务器目录下,运行启动命令 'npx -y @modelcontextprotocol/server-brave-search' 启动 MCP 服务器。
  2. 客户端配置: 在 MCP 客户端 (如 Claude) 中,根据上述 服务器配置 部分的信息,配置并添加 'brave-search' 服务器。
  3. 使用搜索工具: 在 MCP 客户端中,你可以指示 LLM 使用 'brave_web_search' (网络搜索) 或 'brave_local_search' (本地搜索) 工具来执行信息检索任务。 LLM 将会调用 'brave-search' 服务器,并返回搜索结果。

信息

分类

网页与API