Remote MCP Client 仓库使用说明

项目简介

Remote-MCP 是一个为 Model Context Protocol (MCP) 提供远程访问能力的库。它包含服务端和客户端组件，旨在弥补官方MCP远程支持的空缺，使开发者能够立即构建和使用远程MCP服务。该项目通过 tRPC 框架实现了类型安全、双向且简单的远程 MCP 通信。

主要功能点

远程 MCP 服务端: 提供了 '@remote-mcp/server' 库，用于快速搭建可远程访问的 MCP 服务器。
本地 MCP 客户端代理: 提供了 '@remote-mcp/client' 库，作为本地 MCP 客户端的代理，连接到远程 MCP 服务器，使得本地客户端能够透明地使用远程服务器提供的资源、工具和 Prompt。
类型安全: 基于 TypeScript 和 tRPC 构建，保证了客户端和服务器之间通信的类型安全。
示例丰富: 提供了 Cloudflare Workers 和 Standalone Node.js 的服务端示例，方便用户快速上手。
核心 MCP 功能支持: 实现了 MCP 协议中定义的核心功能，包括工具 (Tools)、资源 (Resources) 和 Prompt 模板 (Prompts) 的管理和访问。

安装步骤

服务端安装 (如果你想搭建远程 MCP 服务器):

npm install @remote-mcp/server

客户端代理安装 (如果你想连接到远程 MCP 服务器):

npm install @remote-mcp/client @trpc/client@next zod

服务器配置 (MCP 客户端)

为了让 MCP 客户端连接到 Remote-MCP 服务器，您需要配置客户端的 'mcpServers'，将 '@remote-mcp/client' 作为本地 MCP 服务器启动，并配置其连接到远程服务器的地址。以下是一个典型的 MCP 客户端配置示例 (JSON 格式):

{
  "mcpServers": {
    "remote-mcp": {
      "command": "npx",
      "args": ["-y", "@remote-mcp/client"],
      "env": {
        "REMOTE_MCP_URL": "http://your-remote-mcp-server-address:9512",  // **(必填)** 远程 MCP 服务器的 URL 地址，请替换为实际地址
        "HTTP_HEADER__Authorization": "Bearer your_token"  // **(可选)** 如果远程 MCP 服务器需要认证，在此处设置 Authorization Header，请替换为实际 Token
        // 可以根据远程服务器的需求添加其他以 HTTP_HEADER__ 开头的环境变量作为请求头
      }
    }
  }
}

配置参数说明:

'server name': '"remote-mcp"' (服务器名称，可以自定义)
'command': '"npx"' (Node Package Execute 命令，用于执行 npm 包)
'args': '["-y", "@remote-mcp/client"]' (传递给 'npx' 的参数，用于运行 '@remote-mcp/client' 客户端代理)
'env': 环境变量配置，用于 '@remote-mcp/client' 客户端代理连接远程服务器:
- 'REMOTE_MCP_URL': (必填) 请务必替换为您的远程 MCP 服务器的实际地址 (例如 'http://your-domain.com:9512')。客户端代理将通过这个 URL 连接到远程服务器。
- 'HTTP_HEADER__Authorization': (可选) 如果您的远程 MCP 服务器需要身份验证，请设置此环境变量来添加 'Authorization' 请求头。请替换 'your_token' 为您的实际身份验证令牌。
- 'HTTP_HEADER__<header-name>': (可选) 您可以添加其他以 'HTTP_HEADER__' 开头的环境变量来设置额外的 HTTP 请求头。例如，'HTTP_HEADER__X_CUSTOM_HEADER' 将会被转换为请求头 'X-Custom-Header'。

基本使用方法

部署远程 MCP 服务器: 使用 '@remote-mcp/server' 库 (参考仓库 'examples' 目录下的示例) 创建并部署您的远程 MCP 服务器。确保服务器运行在可通过 'REMOTE_MCP_URL' 访问的地址。
配置 MCP 客户端: 按照上述 "服务器配置 (MCP 客户端)" 部分的说明，配置您的 MCP 客户端，使其通过 '@remote-mcp/client' 连接到您的远程 MCP 服务器。
在 MCP 客户端中使用: 配置完成后，您的 MCP 客户端就可以像使用本地 MCP 服务器一样，透明地使用远程 MCP 服务器提供的工具、资源和 Prompt 了。客户端的请求会被 '@remote-mcp/client' 代理转发到远程服务器，并将响应返回给客户端。

关键词