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 文檔