Cloudflare API

🚀 云flare-api-mcp

云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

2. 打开 Cursor 设置 -> MCP -> 添加新的 MCP 服务器，粘贴剪贴板中的命令。
3. 将您的 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

2. 重新加载您的 Cursor 窗口以查看新工具。

✨ 主要特性

此 MCP 服务器允许代理（例如 Cursor）与 Cloudflare REST API 接口。

📦 安装指南

自动化安装

运行以下命令克隆此 MCP 服务器并部署到您的 Cloudflare 账户：

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

配置 Cursor

打开 Cursor 设置 -> MCP -> 添加新的 MCP 服务器，粘贴剪贴板中的命令。

上传 API 密钥和电子邮件

将您的 Cloudflare API 密钥和电子邮件上传到工人秘密：

bunx wrangler secret put CLOUDFLARE_API_KEY
bunx wrangler secret put CLOUDFLARE_API_EMAIL

💻 使用示例

基础用法

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

高级用法

创建新的 MCP 工具

要创建新的 MCP 工具，请将方法添加到 src/index.ts 中的 MyWorker 类。每个函数将成为代理可以使用的 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 标签指定返回值和类型

📚 详细文档

• 模型控制协议文档
• create-mcp 文档
• workers-mcp
• Cloudflare Workers 文档
• Cloudflare API 文档