关键词

Cloudflare APIServerless FunctionsCloud ServicesInfrastructure ManagementAutomation

项目简介

Cloudflare API MCP 是一个基于 Model Context Protocol (MCP) 构建的轻量级服务器，它被设计为部署在 Cloudflare Workers 上，并允许 LLM 客户端（如 Cursor 编辑器）通过工具的方式与 Cloudflare REST API 进行交互。该服务器提供了一系列预定义的工具，涵盖了 Cloudflare 服务的常用操作，例如 DNS 记录管理、KV 存储操作、R2 对象存储管理等。

主要功能点

  • 工具化 Cloudflare API: 将 Cloudflare REST API 的各种功能封装成易于 LLM 客户端调用的 MCP 工具。
  • 支持多种 Cloudflare 服务: 目前已支持 DNS、Cache、KV 存储、R2 存储、Hyperdrive、Queues、Workers Domains、Workers Cron Triggers 和 Workflows 等 Cloudflare 服务。
  • Cloudflare Workers 部署: 基于 Cloudflare Workers 平台构建，利用其serverless特性，易于部署和扩展。
  • 快速安装脚本: 提供自动化安装脚本，简化部署流程。
  • 热重载: 支持本地开发模式，方便工具的开发和调试。

安装步骤

  1. 使用 'create-mcp' 自动化安装脚本: 打开终端并运行以下命令，这将克隆仓库并部署到您的 Cloudflare 账户。

    bun create mcp --clone https://github.com/zueai/cloudflare-api-mcp

  2. 在 Cursor 中添加 MCP 服务器: 打开 Cursor 编辑器的设置，找到 "MCP" -> "Add new MCP server"，粘贴安装步骤 1 完成后复制到剪贴板的命令。

  3. 上传 Cloudflare API 密钥和邮箱到 Worker Secrets: 运行以下命令，将您的 Cloudflare API 密钥和邮箱设置为 Cloudflare Worker 的 secrets。请替换 '<your-cloudflare-api-key>' 和 '<your-cloudflare-api-email>' 为您的实际信息。

    bunx wrangler secret put CLOUDFLARE_API_KEY
bunx wrangler secret put CLOUDFLARE_API_EMAIL

服务器配置

对于 MCP 客户端（例如 Cursor），您需要配置 MCP 服务器的连接信息。根据仓库信息，配置信息如下：

{
  "serverName": "Cloudflare API MCP Server",
  "command": "",
  "args": []
}

配置参数说明:

  • '"serverName"': MCP 服务器的名称，您可以自定义。例如 '"Cloudflare API MCP Server"'。
  • '"command"': 留空。由于此 MCP 服务器部署在 Cloudflare Workers 上，客户端实际上是通过 Worker 的 URL 进行访问，而不是本地启动一个命令。Cursor 等 MCP 客户端在配置 HTTP MCP 服务器时，通常只需要在客户端的 MCP 设置中填入部署后的 Cloudflare Worker URL 即可，无需配置 'command' 和 'args'。 请在成功部署 Cloudflare Worker 后，将 Worker 的 URL 地址配置到 MCP 客户端中。

注意: 安装步骤完成后，'bun create mcp' 脚本应该会将部署 Cloudflare Worker 的命令（包含 Worker 的 URL）复制到您的剪贴板。您需要将 那个命令 粘贴到 Cursor 的 MCP 服务器配置中。 通常情况下，那个命令可能类似于 'wrangler deploy --name your-worker-name'，执行成功后会输出 Worker 的 URL。 请仔细查看安装脚本的输出信息，找到并使用正确的部署命令或 Worker URL。

基本使用方法

  1. 安装和配置完成后，重启 MCP 客户端 (如 Cursor)。
  2. 在客户端中，您应该能够看到 Cloudflare API MCP 服务器提供的工具列表。 这些工具通常会按照 'src/index.ts' 文件中定义的方法和 JSDoc 注释进行展示。
  3. 根据工具的描述和参数，在客户端中调用相应的工具来管理您的 Cloudflare 服务。 例如，您可以调用 'listZones' 工具来列出您的 Cloudflare 区域，或者使用 'createDNSRecord' 工具来创建新的 DNS 记录。
  4. 工具的参数通常会以友好的表单形式展示在客户端界面上，您只需要根据提示填写参数值即可。 某些工具可能需要 Cloudflare 账户 ID、Zone ID 等信息，请确保您已准备好这些信息。
  5. 工具执行结果会以 JSON 格式返回，并在客户端界面上展示。 您可以查看返回的 JSON 数据来了解工具执行的具体结果。

重要提示:

  • 安全性: 请妥善保管您的 Cloudflare API 密钥和邮箱，不要泄露给他人。建议使用 Cloudflare Worker Secrets 来安全地存储这些敏感信息。
  • 权限控制: 请确保您的 API 密钥拥有执行 MCP 服务器提供的工具所需 Cloudflare API 权限。
  • 参数理解: 使用工具前，请仔细阅读工具的描述和参数说明，确保您理解每个参数的含义和作用。

信息

分类

开发者工具

访问项目