跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com
所有 Agent
GitHub Copilot iconGitHub Copilot icon

GitHub Copilot + Cloudflare

GitHub

GitHub 推出的编辑器扩展和 CLI,支持 Agent 模式、工作区上下文和原生 PR 集成。

终端云端扩展

快速入门

  1. 安装 GitHub Copilot

    从 Visual Studio Marketplace ↗ 在 VS Code 中安装 GitHub Copilot 扩展。针对 JetBrains IDE、Visual Studio 或 Xcode,请参阅安装 Copilot 扩展 ↗指南。

  2. 安装 Cloudflare Skills

    npx skills add https://github.com/cloudflare/skills
  3. 配置 Cloudflare MCP 服务器

    针对 VS Code,添加到 .vscode/mcp.json。针对 Copilot CLI,针对用户级配置添加到 ~/.copilot/mcp-config.json,或针对项目级配置添加到 .mcp.json 或 .github/mcp.json。针对特定领域的 MCP 服务器,请参阅 mcp-server-cloudflare ↗。针对完整的 Cloudflare API MCP 服务器 (Code Mode),请参阅 cloudflare/mcp ↗。

    {
      "mcpServers": {
        "cloudflare": { "url": "https://mcp.cloudflare.com/mcp" }
      }
    }
  4. 尝试提示词

    打开 Copilot Chat (Ctrl+Shift+I),切换到 Agent 模式,并尝试提示词 — 例如:

    配置缓存规则和缓存 TTL,降低电商站点的源站负载。

Cloudflare 平台访问权限

展开任意部分以了解更多。

Cloudflare Skills

持久的平台上下文,教会 Agent Cloudflare 如何工作。

Skills 是 Agent 按需加载的说明。 cloudflare/skills 包覆盖平台的每一层 — 因此 Agent 了解你的约定,无需你反复解释。

  • agents-sdkBuild, debug, or review Cloudflare Agents SDK applications using the agents package.
  • basinBuild and troubleshoot Cloudflare Basin analytics workflows with Basin Pipelines, Basin Catalog, and Basin SQL. Use for streaming data into R2 Iceberg tables, managing catalogs, or querying those tables; also use for requests using the former Data Platform, Pipelines, R2 Data Catalog, or R2 SQL names.
  • cf-cliCloudflare's official cf CLI (beta) for the public Cloudflare API and Workers projects. Use for finding and running Cloudflare commands from the terminal — sign-in and profiles, cf cli search, cf schema, cf deploy/dev/build, resource commands for DNS, zones, D1, KV, and R2 — and for choosing between cf and Wrangler in a project.
  • cloudflareDiscover and choose Cloudflare products for apps, APIs, AI agents, storage, networking, and security. Use for architecture and product selection, including when the user describes a need without naming a Cloudflare product; then find the relevant skill or documentation. Also use when a Cloudflare-proxied site shows a Cloudflare error page, a `52x` status, a 1xxx error code, or a Cloudflare `403`, to decide whether to fix Cloudflare configuration or the origin.
  • cloudflare-app-bootstrapGet a Cloudflare Workers app to a working local request by connecting its bindings, secrets, and initial data, then verifying real application behavior. Use for app setup or onboarding after the project exists; use frameworks-on-cloudflare or cf-cli to create or configure the project, and wrangler or cf-cli for isolated commands.
  • cloudflare-email-serviceImplement or troubleshoot Cloudflare Email Sending and Email Routing integrations and their delivery configuration.
  • cloudflare-oneDesign, configure, troubleshoot, or review Cloudflare One Zero Trust and SASE deployments. Use cloudflare-one-migrations for migration planning from other vendors. Also use when an agent, script, crawler, or other non-browser client needs to reach a webpage or API protected by Cloudflare Access.
  • cloudflare-one-migrationsAssess and plan migrations from existing VPN, SWG, or SASE platforms to Cloudflare One, including policy mapping, parity gaps, and rollout.
  • durable-objectsBuild, debug, or review Cloudflare Durable Objects code for persistent state and coordination.
  • frameworks-on-cloudflareBuild, migrate, and deploy web-framework applications on Cloudflare Workers. Use when a framework project such as Astro, SvelteKit, React Router, TanStack Start, Nuxt, Hono, or a React or Vue SPA targets Cloudflare, or when a framework repository contains Workers deployment configuration.
  • gateway-workersBuild, debug, or review Cloudflare Workers invoked by the Forward action in Gateway HTTP policies, including the GatewayMiddleware entrypoint, Gateway types, context, and continuation.
  • k2Build and troubleshoot Cloudflare K2 or K2 Streams durable logs. Use for stream setup, producing from Workers or HTTP, configuring retention and inputs, and consuming through subscriptions.
  • nextjs-on-cloudflareBuild, migrate, and deploy Next.js apps on Cloudflare Workers with vinext. Use when starting a Next.js project on Cloudflare, moving an existing app to Workers, choosing between vinext and OpenNext, or setting up vinext for Workers. For setup, migration, or deployment, install vinext's upstream skills with `npx skills add cloudflare/vinext` if missing, then read and follow the applicable skill and docs.
  • sandbox-migrate-to-nextMigrate Cloudflare Sandbox apps from stable @cloudflare/sandbox to @cloudflare/sandbox@next (SDK 1.0 preview). Use sandbox-next for apps already on the preview.
  • sandbox-nextBuild or maintain Cloudflare Sandbox apps on @cloudflare/sandbox@next (SDK 1.0 preview). Use sandbox-migrate-to-next when porting a stable app.
  • sandbox-stableBuild or maintain Cloudflare Sandbox apps on the stable @cloudflare/sandbox package. Use sandbox-next for preview apps and sandbox-migrate-to-next for stable-to-preview migrations.
  • turnstile-spinSet up, repair, or migrate to Cloudflare Turnstile bot verification in an existing frontend and backend, including server-side Siteverify.
  • web-perfAudit, diagnose, or optimize website loading and interaction performance, Core Web Vitals, and Lighthouse performance scores.
  • workers-best-practicesCloudflare Workers best practices for production applications. Use when writing, reviewing, or configuring Workers.
  • workers-developmentRun, inspect, and debug Cloudflare Workers during local development with cf dev, wrangler dev, or the Cloudflare Vite plugin, using Local Explorer to read and seed binding data and query local traces and logs. Also routes production debugging to Workers observability. Use for debugging requests whether or not the project uses Wrangler.
  • workers-profilingProfile or debug CPU usage and memory allocation in deployed Cloudflare Workers and Durable Objects. Then use this information to optimize your code.
  • wranglerRun or troubleshoot Wrangler CLI commands in projects that have a wrangler.jsonc, wrangler.json, or wrangler.toml file, including local development, Previews, deployment, and resource management. For new projects and projects without a Wrangler configuration file, use the cf CLI instead.
MCP 服务器

实时访问 Cloudflare API、文档和可观测性。

MCP 服务器提供类型化工具,以便在运行时调用 Cloudflare。有两种选择:Code Mode — 一台覆盖整个 Cloudflare API 的服务器(约 1,000 个 token 覆盖 2,500+ 个端点)— 或者一组聚焦特定领域的服务器,托管在 cloudflare/mcp-server-cloudflare 仓库中。完整目录也在 Cloudflare 的 MCP 服务器 文档中。

  • Cloudflare API MCP ServerCode ModeBest when you want broad access across Cloudflare's APIs through code executionhttps://mcp.cloudflare.com/mcp
  • Code mode APICode ModeBroad access to the full Cloudflare API via code execution, with minimal token overheadhttps://mcp.cloudflare.com/mcp
  • Browser Run serverFetch web pages, convert them to markdown and take screenshotshttps://browser.mcp.cloudflare.com/mcp
  • Cloudflare Blog serverSearch and read posts from the Cloudflare Bloghttps://blog.mcp.cloudflare.com/mcp
  • Cloudflare One CASB serverQuickly identify any security misconfigurations for SaaS applications to safeguard users & datahttps://casb.mcp.cloudflare.com/mcp
  • Container serverSpin up a sandbox development environmenthttps://containers.mcp.cloudflare.com/mcp
  • Demo Day serverDemonstrate a minimal Cloudflare MCP serverhttps://demo-day.mcp.cloudflare.com/mcp
  • Digital Experience Monitoring serverGet quick insight on critical applications for your organizationhttps://dex.mcp.cloudflare.com/mcp
  • Documentation serverGet up-to-date reference information on Cloudflarehttps://docs.mcp.cloudflare.com/mcp
Wrangler CLI

本地开发、部署和 Workers 专用命令。

使用 Wrangler 进行本地开发、部署以及运行产品专用命令,例如 wrangler d1 migrations apply 或 wrangler tail。 捆绑的 wrangler Skill 会教 Agent 何时使用它。

面向 Agent 的文档

为 Agent 优化的、节省 token 的参考资料。

在任意 Cloudflare 文档 URL 后追加 /index.md 即可获得干净的 Markdown 版本。每个顶级产品部分也有自己的 llms.txt — 一份适合单个上下文窗口的页面索引。常用文件包括:

关于这些文档如何面向 Agent 组织的完整概览,请参阅面向 Agent 的文档指南。

示例提示词

技巧与建议

  • Cloudflare API MCP 服务器使用 Code Mode — Copilot 在约 1,000 个 token 内针对类型化的 API 编写 JavaScript 以访问 2,500+ 个端点中的任何一个。
  • 在 Copilot Chat 中使用 @workspace,在要求 Agent 进行构建或部署前,赋予其你 Workers 项目的完整上下文。
  • 提交包含存储库级约定的 .github/copilot-instructions.md 文件 — Copilot 会在每次交互中自动加载它,补充按需加载的 Skills。

常见问题 (FAQ)

Does Copilot support Cloudflare Skills?

是的。GitHub Copilot 为 VS Code Agent 模式、Copilot CLI 和 云 Agent 添加了 Agent Skills 支持。运行 npx skills add https://github.com/cloudflare/skills 来安装它们。请参阅关于 Agent Skills ↗ 指南,获取有关 Copilot 在何处查找 Skills 的详细信息。

Should I use Skills, the MCP server, a CLI, or all of them?

三个都要用。Skills 会在每次 Agent 模式会话中提供 Cloudflare 专业知识。 Cloudflare API MCP 服务器负责平台操作(DNS、WAF、Zero Trust、R2 存储桶)。Wrangler 在 VS Code 终端中运行本地开发和部署。随附的 wrangler Skill 会教 Copilot 在何时使用 哪种工具。对于涉及整个 Cloudflare API 的任务,Copilot 还可以使用 Cloudflare CLI cf。

Can Copilot use the Cloudflare CLI?

可以。Cloudflare CLI cf 处于 Beta 阶段,涵盖整个 Cloudflare API,并输出 JSON。通过 npm install -g cf 安装,使用 cf auth login 登录,再在 .github/copilot-instructions.md 或 AGENTS.md 中告诉 Copilot 优先使用它。参见让 AI Agent 使用 cf。

Do I still need .github/copilot-instructions.md?

它们是互补的。对几乎适用于每个任务的简单存储库级 约定(编码标准、首选库)使用自定义说明。对 Copilot 仅需在相关时 加载的详细、情境性指导使用 Skills。

Can Copilot deploy to Cloudflare directly?

可以,通过 VS Code 终端中的 Wrangler 或 cf,或通过 Copilot 为你生成的 GitHub Actions 工作流程来完成。

故障排查

Skills do not load in Copilot

Skills 仅在 VS Code Agent 模式、Copilot CLI 和云 Agent 中有效 — 无法与行内补全或普通聊天配合使用。将 Copilot Chat 切换到 Agent 模式。如果仍然无法发现 Skills,请参阅关于 Agent Skills ↗ 了解 Copilot 检查的路径。

MCP server not available in VS Code

确保你使用的是原生支持 MCP 的 VS Code 1.99+。将 服务器配置添加到 .vscode/mcp.json。

Getting outdated information about Cloudflare products

让 Agent 直接访问 developers.cloudflare.com/llms.txt,查看 所有产品的目录;或者访问 developers.cloudflare.com/<product>/llms.txt, 查看特定产品的索引。

在 Cloudflare 上构建 Agent

另外值得了解

Cloudflare 不只是 Agent 的部署目标,也是用来构建你自己 Agent 的完整技术栈。

其他 Agent

这篇文档对您有帮助吗?