使用说明

项目简介

本项目实现了一个MCP(Model Context Protocol)服务器,该服务器通过标准输入输出(stdio)提供服务,并对外暴露一个名为 'search_web' 的工具。此工具利用OpenRouter平台的在线模型进行网页搜索,旨在为大型语言模型(LLM)客户端提供简洁、及时的网络信息检索功能。

主要功能点

  • MCP协议兼容: 遵循Model Context Protocol,可以与任何兼容MCP协议的LLM客户端进行通信。
  • 联网搜索工具: 提供 'search_web' 工具,允许LLM客户端通过简单的文本查询,获取来自互联网的最新信息。
  • OpenRouter模型驱动: 使用OpenRouter平台提供的强大语言模型进行搜索结果的生成,保证答案的质量和时效性。
  • 可配置模型: 允许用户通过环境变量 'MODEL_NAME' 自定义使用的OpenRouter模型,默认为 'google/gemini-2.5-pro-exp-03-25:free:online'。
  • 简易部署: 通过 'go install' 命令即可完成安装,配置简单,易于集成到现有的LLM应用架构中。

安装步骤

  1. 安装 Go 环境: 确保你的开发环境已安装 Go 1.18 或更高版本。
  2. 安装 MCP 服务器: 打开终端,运行以下命令安装 'openrouter-websearch-mcp':
    go install github.com/ChristianSch/openrouter-websearch-mcp
    安装成功后,可执行文件 'openrouter-websearch-mcp' 将位于 '$GOPATH/bin' 目录(通常为 '~/go/bin')。请确保该目录已添加到系统的 'PATH' 环境变量中。

服务器配置

MCP客户端需要配置服务器的启动信息,以下是一个典型的JSON配置示例,用于告知MCP客户端如何启动和连接 'openrouter-websearch-mcp' 服务器:

{
    "mcpServers": {
        "web-search": {  // 服务器名称,客户端用此名称引用
            "command": "openrouter-websearch-mcp", // 启动服务器的命令,这里假设 openrouter-websearch-mcp 可执行文件已在 PATH 环境变量中
            "env": {
                "OPENROUTER_API_KEY": "sk-or-v1-your-openrouter-api-key" // 必须配置:你的 OpenRouter API 密钥,请替换为实际密钥
                // "MODEL_NAME": "openrouter/anthropic-claude-v2:online"  // 可选配置:指定使用的 OpenRouter 模型,默认为 google/gemini-2.5-pro-exp-03-25:free:online,如需更换请取消注释并修改
            }
        }
    }
}

配置说明:

  • '"web-search"': 自定义的服务器名称,客户端通过此名称来引用该服务器。
  • '"command": "openrouter-websearch-mcp"': 指定启动 MCP 服务器的命令。请确保 'openrouter-websearch-mcp' 可执行文件在系统的 'PATH' 环境变量中,或者使用可执行文件的完整路径。
  • '"env"': 环境变量配置,用于传递服务器运行所需的参数。
    • '"OPENROUTER_API_KEY"': 必填,你的 OpenRouter API 密钥。请务必替换 '"sk-or-v1-your-openrouter-api-key"' 为你真实的 API 密钥。
    • '"MODEL_NAME"': 选填,指定要使用的 OpenRouter 模型名称。如果省略,服务器将使用默认模型 'google/gemini-2.5-pro-exp-03-25:free:online'。如果需要使用其他模型,请取消注释并修改为所需的模型名称,务必确保模型名称带有 ':online' 后缀,例如 '"openrouter/anthropic-claude-v2:online"'。

基本使用方法

  1. 启动 MCP 服务器: MCP客户端根据上述配置启动 'openrouter-websearch-mcp' 服务器。服务器启动后,将通过标准输入输出与客户端进行通信。

  2. 客户端调用 'search_web' 工具: 在LLM客户端中,可以使用配置的服务器名称 '"web-search"' 和工具名称 '"search_web"' 来调用联网搜索功能。例如,客户端可以发送如下格式的MCP请求(JSON-RPC over stdio):

    {
      "jsonrpc": "2.0",
      "method": "call_tool",
      "params": {
        "server_name": "web-search",
        "tool_call": {
          "tool_name": "search_web",
          "arguments": {
            "query": "最新的AI技术发展趋势" //  这里是你的搜索查询
          }
        }
      },
      "id": 1
    }
  3. 接收搜索结果: MCP服务器执行 'search_web' 工具后,会将搜索结果封装成MCP响应返回给客户端。客户端解析响应即可获取联网搜索的结果。

注意: 使用前请务必配置正确的 'OPENROUTER_API_KEY' 环境变量。如果需要更换OpenRouter模型,请配置 'MODEL_NAME' 环境变量。

信息

分类

网页与API