关键词

Cloudflare WorkersMCPOAuth远程上下文服务工具注册

使用说明

项目简介

该项目是一个基于 Model Context Protocol (MCP) 构建的远程MCP服务器实现，旨在演示如何在 Cloudflare Workers 上快速搭建一个具备 OAuth 登录认证的 MCP 服务器。它允许开发者在 Cloudflare 的serverless环境中部署 MCP 服务器，为 LLM 应用提供可扩展和安全的上下文服务。

主要功能点

  • 资源管理: 虽然示例代码中没有显式展示资源管理功能，但作为 MCP 服务器的基础能力，该实现应具备资源管理框架，以便后续扩展。
  • 工具注册与执行: 示例中注册了一个简单的 'add' 工具，演示了工具的定义和执行流程。
  • Prompt 模板渲染: 作为 MCP 服务器的核心功能之一，该实现应支持 Prompt 模板的定义和渲染，以支持定制化的 LLM 交互模式 (代码中未直接体现，但 MCP Server 的定义包含此功能)。
  • OAuth 登录认证: 集成了 OAuth 登录认证，为 MCP 服务器提供安全访问控制。
  • SSE 传输协议: 使用 Server-Sent Events (SSE) 作为默认的客户端-服务器通信协议。
  • Cloudflare Workers 部署: 基于 Cloudflare Workers 平台，易于部署和扩展。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/Rev4nchist/cloudflare-remote-mcp-server.git
cd cloudflare-remote-mcp-server

  2. 安装依赖:

    npm install

  3. 本地开发运行:

    npx nx dev remote-mcp-server

    运行后，您可以通过浏览器访问 'http://localhost:8787/' 来查看服务器是否正常运行。

  4. 部署到 Cloudflare Workers:

    • 确保您已安装 Wrangler CLI。
    • 创建 Cloudflare KV 命名空间： 
      npx wrangler kv namespace create OAUTH_KV
      按照提示将 KV 命名空间 ID 添加到 'wrangler.jsonc' 文件中。
    • 部署 Worker： 
      npm run deploy
      部署成功后，Wrangler CLI 将会提供一个 'workers.dev' 子域的 URL，即您的远程 MCP 服务器地址。

服务器配置

MCP 服务器的配置主要在服务器端完成，客户端无需复杂配置。对于 MCP 客户端（如 Claude Desktop 或 MCP Inspector），您需要配置 MCP 服务器的连接信息。

以下是 MCP 客户端需要配置的 MCP服务器启动命令 (command) 及其参数 (args) 的 JSON 格式配置信息，用于连接到该 Cloudflare Remote MCP Server：

{
  "server name": "cloudflare-remote-mcp-server",
  "command": "npx mcp-remote",
  "args": [
    "您的 Cloudflare Worker SSE Endpoint"  // 将 "您的 Cloudflare Worker SSE Endpoint" 替换为部署后获取的 'workers.dev' URL，例如 "https://your-worker.account.workers.dev/sse"
  ]
}

参数注释:

  • '"server name"': MCP 服务器的自定义名称，客户端用于标识和管理不同的 MCP 服务器连接。可以根据您的需要自定义，例如 "cloudflare-mcp-server"。
  • '"command"': MCP 客户端用于启动本地代理的命令，固定为 '"npx mcp-remote"'，无需修改。
  • '"args"': 传递给 'mcp-remote' 命令的参数，是一个字符串数组。
    • 数组的第一个元素是 您的 Cloudflare Worker SSE Endpoint，这是您部署的 Cloudflare Remote MCP Server 的 SSE 接口地址。您需要将其替换为您实际部署后获取的 'workers.dev' URL，并确保 URL 以 '/sse' 结尾。

请注意: MCP 客户端（如 Claude）不需要 配置服务器的安装步骤或部署命令，因为它只需要连接到已经运行的 MCP 服务器。上述 JSON 配置信息是用于指导 MCP 客户端如何与远程 MCP 服务器建立连接的关键，特别是 'args' 字段中的服务器 SSE Endpoint URL。

基本使用方法

  1. 启动 MCP Inspector 或配置 Claude Desktop: 按照仓库 README 中的 "Connect the MCP inspector to your server" 或 "Connect Claude Desktop to your local MCP server" 部分的指引操作，配置客户端连接到本地或远程部署的 MCP 服务器。
  2. OAuth 登录: 首次连接时，客户端会引导您进行 OAuth 登录认证。使用任意邮箱和密码即可完成模拟登录。
  3. 体验 MCP 功能: 成功连接后，您可以在 MCP Inspector 中浏览和调用已注册的工具，或者在 Claude Desktop 中通过 Prompt 触发工具调用，体验 MCP 服务器提供的上下文服务。

调试

如果遇到问题，可以参考 README 中的 "Debugging" 部分，例如重启 Claude、使用 'npx mcp-remote' 命令行工具直接连接服务器，或清理本地认证缓存等方法进行调试。

信息

分类

开发者工具

访问项目