基本能力
产品定位
cloudflare-api-mcp 是一个基于 Cloudflare Workers 的 MCP 服务器,旨在为代理(如 Cursor)提供与 Cloudflare API 交互的能力。
核心功能
- 与 Cloudflare API 交互:通过 MCP 协议调用 Cloudflare API 的功能。
- 动态工具扩展:开发者可以通过在
src/index.ts
中添加方法来自定义新的 MCP 工具。 - 轻量级部署:部署在 Cloudflare Workers 上,无需复杂的基础设施。
适用场景
- 开发工具集成:为开发工具(如 Cursor)提供 Cloudflare API 的访问能力。
- 自动化脚本:通过 MCP 协议自动化执行 Cloudflare API 操作(如 DNS 记录管理)。
- 快速原型开发:快速构建基于 Cloudflare API 的工具或服务。
工具列表
工具列表定义在 src/index.ts
中,每个方法都是一个 MCP 工具。例如:
createDNSRecord
:在指定区域创建 DNS 记录。- 参数:
zoneId
(区域 ID)、name
(记录名称)、content
(记录内容)、type
(记录类型)、comment
(可选注释)、proxied
(是否代理)。 - 返回值:创建的 DNS 记录对象。
常见问题解答
- 如何添加新工具?
- 在
src/index.ts
的MyWorker
类中添加方法,并确保包含 JSDoc 注释。 - 如何部署?
- 运行
bun run deploy
并重新加载 Cursor 窗口。 - 如何设置本地开发环境?
- 在
.dev.vars
文件中添加 Cloudflare API 密钥和邮箱。
使用教程
使用依赖
- 安装 Bun 运行时环境(如果尚未安装)。
- 安装 Cloudflare Workers CLI(wrangler):
bash
bun install -g wrangler
安装教程
- 运行自动化安装脚本:
bash
bun create mcp --clone https://github.com/zueai/cloudflare-api-mcp - 在 Cursor 设置中添加 MCP 服务器,并粘贴复制的命令。
- 上传 Cloudflare API 密钥和邮箱到 Worker Secrets:
bash
bunx wrangler secret put CLOUDFLARE_API_KEY
bunx wrangler secret put CLOUDFLARE_API_EMAIL
调试方式
- 本地开发时,在
.dev.vars
文件中配置 API 密钥和邮箱。 - 运行本地测试:
bash
bun run dev - 部署后重新加载 Cursor 窗口以查看新工具。