使用说明

项目简介

'rsus' 是一个基于 Model Context Protocol (MCP) 的服务器实现，它利用 Brave Search API 提供强大的网页和本地搜索功能。通过部署此服务器，LLM 客户端可以便捷地调用 'brave_web_search' 和 'brave_local_search' 工具，从而扩展 LLM 的信息检索能力。

主要功能点

网页搜索: 支持关键词进行网页内容搜索，适用于查找新闻、文章、通用信息等。具备分页浏览和结果新鲜度控制功能。
本地搜索: 能够查找本地商家、餐厅和服务信息，并提供详细的地址、评分、联系方式等。当本地搜索无结果时，能自动fallback到网页搜索，确保信息覆盖。
灵活的搜索控制: 允许客户端通过参数控制搜索结果类型、安全级别和内容的新鲜度。
工具集成: 以 MCP 工具的形式向 LLM 客户端暴露搜索功能，方便 LLM 按需调用。

安装步骤

前提条件: 确保你的开发环境已安装 Node.js 和 npm (或 yarn)。

克隆仓库: 将 'rsus' 仓库克隆到本地：

git clone https://github.com/hetpagit/rsus.git
cd rsus

安装依赖: 在仓库根目录下运行 npm install 命令安装项目依赖：
```
npm install
```
配置 API 密钥: 访问 Brave Search API 官网注册并获取 API 密钥。免费套餐提供每月2,000次查询。
设置环境变量: 将获取到的 Brave Search API 密钥设置为名为 'BRAVE_API_KEY' 的环境变量。

服务器配置

对于支持 MCP 协议的 LLM 客户端（例如 Claude Desktop），你需要配置 MCP 服务器的启动命令。以下是 Claude Desktop 客户端的 'claude_desktop_config.json' 配置文件示例，用于连接 'rsus' MCP 服务器：

{
  "brave-search": {
    "command": "npx",
    "args": ["-y", "@modelcontextprotocol/server-brave-search"],
    "env": {
      "BRAVE_API_KEY": "YOUR_API_KEY_HERE"  // 替换为你的 Brave API 密钥
    }
  }
}

配置参数说明:

'"brave-search"': 服务器名称，客户端用以识别和调用。
'"command": "npx"': 启动服务器的命令，这里使用 'npx' 来执行 npm 包。
'"args": ["-y", "@modelcontextprotocol/server-brave-search"]': 传递给 'npx' 的参数。'-y' 标志用于跳过安装包时的确认提示，'@modelcontextprotocol/server-brave-search' 是服务器的 npm 包名 (请注意，根据仓库内容，实际运行可能需要调整为 'node index.js' 或 'npm start'，但此处根据仓库提供的 Claude Desktop 配置示例填写)。
'"env"': 环境变量配置，'BRAVE_API_KEY' 用于存储你的 Brave Search API 密钥，请务必替换 '"YOUR_API_KEY_HERE"' 为你实际的 API 密钥。

基本使用方法

启动服务器: 根据你的配置方式启动 MCP 服务器。如果使用 'claude_desktop_config.json' 示例配置，客户端启动时会自动尝试连接。如果手动运行，可能需要在仓库目录下执行 'npm start' 或 'node index.js' 命令。
客户端调用: 在 LLM 客户端中，通过 MCP 协议调用已注册的工具 'brave_web_search' 和 'brave_local_search'，即可使用网页和本地搜索功能。具体调用方式请参考 LLM 客户端的使用文档。例如，在 Claude Desktop 中，你可以在对话中使用 '@brave-search brave_web_search' 或 '@brave-search brave_local_search' 来触发搜索。

关键词