使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,它集成网页搜索功能,允许大型语言模型 (LLM) 客户端通过 MCP 协议调用网页搜索工具。该服务器使用 Serper API 执行搜索,并将结果以结构化的 JSON 格式返回,为 LLM 应用提供实时的网络信息检索能力。

主要功能点

  • 网页搜索工具: 提供名为 'web-search' 的工具,LLM 客户端可以调用此工具进行网页搜索。
  • Serper API 集成: 使用 Serper API 作为后端搜索引擎,保证搜索结果的质量和实时性。
  • JSON 格式返回: 搜索结果以 JSON 格式封装在 MCP 响应中,方便 LLM 客户端解析和使用。
  • 标准 I/O 传输: 支持标准的 stdio 传输协议,易于集成到各种 MCP 客户端环境中。

安装步骤

  1. 获取 Serper API 密钥: 访问 serper.dev 注册并获取 API 密钥。
  2. 克隆仓库: 在本地克隆 GitHub 仓库 'https://github.com/muka/web-search-mcp'。
    git clone https://github.com/muka/web-search-mcp
  3. 进入项目目录: 使用 'cd' 命令进入克隆的项目目录 'web-search-mcp'。
    cd web-search-mcp
  4. 安装依赖: 使用 npm 或 yarn 安装项目依赖。
    npm install
    yarn install
  5. 配置环境变量: 创建 '.env' 文件或设置环境变量,配置 Serper API 密钥和端口号(可选)。
    SERPER_API_KEY=YOUR_SERPER_API_KEY  # 替换为你的 Serper API 密钥
    PORT=3006                      # 可选,指定服务器端口,默认为 3006
  6. 启动服务器: 使用 npm 或 yarn 启动 MCP 服务器。
    npm start
    yarn start
    或者使用 Docker Compose 启动:
    docker compose up

服务器配置

以下 JSON 配置信息可用于 MCP 客户端连接到此服务器:

{
  "serverName": "web-search",
  "command": "npm start",
  "args": [],
  "transport": "stdio"
}

基本使用方法

服务器启动后,MCP 客户端可以通过 stdio 协议与其建立连接。客户端可以发送符合 MCP 协议的 JSON-RPC 请求来调用 'web-search' 工具,并传递包含 'topic' 参数的 JSON 对象作为搜索关键词。服务器会将网页搜索结果封装在 MCP 响应中返回给客户端。

例如,客户端可以发送以下 JSON-RPC 请求来调用 'web-search' 工具搜索 "最新科技新闻":

{
  "jsonrpc": "2.0",
  "method": "executeTool",
  "params": {
    "tool_name": "web-search",
    "arguments": {
      "topic": "最新科技新闻"
    }
  },
  "id": 1
}

服务器会返回包含搜索结果的 JSON-RPC 响应。

信息

分类

网页与API