金大哥 - cloudflare_mcp MCP 详情

article

README

🚀 云flare MCP服务器

这是一个现代的模型 - 上下文 - 协议（MCP）服务器，它将Cloudflare的DNS、安全、重定向和区域设置功能以结构化的工具形式公开，任何兼容的AI客户端（如Claude Desktop）都可以调用这些工具。

✨ 主要特性

丰富的工具目录：涵盖16种读写操作，包括DNS记录、WAF规则、页面规则重定向、缓存清除、区域设置等。
与Claude Desktop即插即用：配备标准输入输出（STDIO）传输，Claude可立即列出并调用工具，无需额外的适配器。
类型安全：使用TypeScript编写，并由@modelcontextprotocol/sdk提供支持，每个工具的参数和返回值都有zod模式。
默认非破坏性：默认禁用具有破坏性的证书订购功能，以防止意外产生费用。
脚本库和测试：提供用于手动操作的一次性脚本，以及Jest集成/单元测试。

🚀 快速开始

# 1. 克隆并安装
npm install

# 2. 配置凭证
cp config/.env.example .env
$EDITOR .env          # 填入你的CLOUDFLARE_API_TOKEN

# 3. 构建并运行服务器（标准输入输出）
npm run build
node dist/index.js    # Claude Desktop将自动检测

需要沙盒环境？Cloudflare Workers免费计划可让你创建测试区域。

🛠️ 工具目录

| 类别 | 工具名称 | 描述 | |------|----------|------| | 通用 | echo | 用于连接性测试的文本往返 | | 区域 | list_zones | 枚举令牌可访问的区域 | | 区域 | get_zone_settings | 返回完整的设置对象 | | 区域 | list_zone_settings | 简短的设置摘要 | | DNS | list_dns_records | 读取所有DNS资源记录集 | | DNS | create_dns_record* | 添加记录 | | DNS | update_dns_record* | 修改记录 | | DNS | delete_dns_record* | 删除记录 | | 安全 | list_waf_rules | 读取防火墙规则 | | 安全 | create_security_rule* | 添加防火墙规则 | | 安全 | update_security_rule* | 编辑防火墙规则 | | 安全 | delete_security_rule* | 删除防火墙规则 | | 重定向 | list_page_rules | 列出重定向/页面规则 | | 重定向 | create_redirect* | 创建重定向 | | 重定向 | delete_page_rule* | 删除重定向 | | 缓存 | purge_cache* | 清除URL或所有缓存 |

* 破坏性操作 - 请谨慎使用。

SSL证书订购/上传功能有意未注册。如有需要，可通过删除src/index.ts中的过滤器来启用它们。

💻 使用示例

基础用法

# 克隆并安装依赖
npm install

# 配置凭证
cp config/.env.example .env
$EDITOR .env          # 填入你的CLOUDFLARE_API_TOKEN

# 构建并运行服务器
npm run build
node dist/index.js    # Claude Desktop将自动检测

高级用法

# 开发模式下编译
npm run dev

# 运行完整测试套件
npm test

# 代码检查
npm run lint

🧑‍💻 开发

# 监听模式编译
npm run dev

# 运行完整测试套件
npm test

# 代码检查
npm run lint

便捷的演示脚本位于scripts/目录下（例如scripts/list-dns-demo.ts）。所有脚本都接受--zone标志。

🔧 技术细节

架构

src/index.ts：入口点；合并工具映射并将其注册到McpServer。
src/tools/：各个工具模块，每个模块导出{ tools, description }。
src/cloudflare-client.ts：围绕axios和CF API基本URL的轻量级包装器。
tests/：Jest测试（单元和集成测试）。

服务器通过标准输入输出使用JSON - RPC 2.0进行通信，具体定义见MCP SDK。详情请参阅docs/API.md。

🤝 贡献

欢迎提交拉取请求（PR）和提出问题！请阅读REFERENCE.md了解编码约定和风格指南。

分叉仓库 → 创建功能分支 → 提交PR。
确保npm test测试通过。
清晰描述工具行为或问题。

📄 许可证

由Windsurf构建

cloudflare_mcp