返回 MCP 目录
public公开dns本地运行

cloudflare-api-mcp

一个基于Cloudflare Workers的轻量级模型控制协议(MCP)服务器,用于通过代理(如Cursor)与Cloudflare REST API交互。

article

README

🚀 云flare-api-mcp

这是一个轻量级的模型控制协议(MCP)服务器,基于 create-mcp 创建,并部署在 Cloudflare Workers 上。该服务器允许代理(如 Cursor)与 Cloudflare REST API 进行交互,为相关操作提供便利。目前项目仍处于开发阶段,后续会按需添加更多工具。

🚀 快速开始

安装

  1. 运行自动化安装脚本,克隆此 MCP 服务器并部署到您的 Cloudflare 账户:
bun create mcp --clone https://github.com/zueai/cloudflare-api-mcp
  1. 打开 Cursor 设置 -> MCP -> 添加新的 MCP 服务器,粘贴安装命令。
  2. 将您的 Cloudflare API 密钥和电子邮件上传到工人秘密:
bunx wrangler secret put CLOUDFLARE_API_KEY
bunx wrangler secret put CLOUDFLARE_API_EMAIL

本地开发

将您的 Cloudflare API 密钥和电子邮件添加到 .dev.vars 文件中:

CLOUDFLARE_API_KEY=<your-cloudflare-api-key>
CLOUDFLARE_API_EMAIL=<your-cloudflare-api-email>

部署

  1. 运行部署脚本:
bun run deploy
  1. 重新加载您的 Cursor 窗口以查看新工具。

✨ 主要特性

  • 轻量级 MCP 服务器,便于部署和使用。
  • 支持代理与 Cloudflare REST API 交互。
  • 可按需添加新的 MCP 工具。

📦 可用工具

查看 src/index.ts 中的当前工具列表。MyWorker 类中的每个方法都是一个 MCP 工具。

💻 使用示例

如何创建新的 MCP 工具

要在 src/index.ts 中的 MyWorker 类中添加方法来创建新的 MCP 工具。每个函数都会自动成为代理可以使用的 MCP 工具。

基础用法

/**
 * 在指定区域创建新的 DNS 记录。
 * @param zoneId {string} 要创建记录的区域 ID。
 * @param name {string} DNS 记录的名称。
 * @param content {string} DNS 记录的内容。
 * @param type {string} DNS 记录的类型(CNAME、A、TXT 或 MX)。
 * @param comment {string} 可选的记录注释。
 * @param proxied {boolean} 可选的是否通过 Cloudflare 代理记录。
 * @return {object} 创建的 DNS 记录。
 */
createDNSRecord(zoneId: string, name: string, content: string, type: string, comment?: string, proxied?: boolean) {
    // 实现
}

注意事项

JSDoc 注释很重要:

  • 第一行成为工具的描述
  • @param 标签定义参数、类型和描述
  • @return 标签指定返回值和类型

📚 详细文档

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端