跳转到内容
搜索文档
All agents
GitHub Copilot iconGitHub Copilot icon

GitHub Copilot + Cloudflare

GitHub

Editor extension and CLI with agent mode, workspace context, and native PR integration. Made by GitHub.

TerminalCloudExtension

快速入门

  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" },
        "cloudflare-docs": { "url": "https://docs.mcp.cloudflare.com/mcp" },
        "cloudflare-bindings": { "url": "https://bindings.mcp.cloudflare.com/mcp" },
        "cloudflare-builds": { "url": "https://builds.mcp.cloudflare.com/mcp" },
        "cloudflare-observability": { "url": "https://observability.mcp.cloudflare.com/mcp" }
      }
    }
  4. 尝试提示词

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

    Set up custom domains with automatic SSL for my SaaS customers using SSL for SaaS.

Cloudflare 平台访问权限

Expand any section to learn more.

Cloudflare Skills

Persistent platform context that teaches the agent how Cloudflare works.

Skills are instructions the agent loads on demand. The cloudflare/skills bundle covers every layer of the platform — so the agent knows your conventions without you re-explaining them.

  • agents-sdkBuild AI agents on Cloudflare Workers using the Agents SDK. Load when creating stateful agents, durable workflows, real-time WebSocket apps, scheduled tasks, MCP servers, chat applications, voice agents, or browser automation. Covers Agent class, state management, callable RPC, Workflows, durable execution, queues, retries, observability, and React hooks. Biases towards retrieval from Cloudflare docs over pre-trained knowledge.
  • cloudflareComprehensive Cloudflare platform skill covering Workers, Pages, storage (KV, D1, R2), AI (Workers AI, Vectorize, Agents SDK), feature flags (Flagship), networking (Tunnel, Spectrum), security (WAF, DDoS), and infrastructure-as-code (Terraform, Pulumi). Use for any Cloudflare development task. Biases towards retrieval from Cloudflare docs over pre-trained knowledge.
  • cloudflare-email-serviceSend and receive transactional emails with Cloudflare Email Service (Email Sending + Email Routing). Use when building email sending (Workers binding or REST API), email routing, Agents SDK email handling, or integrating email into any app — Workers, Node.js, Python, Go, etc. Also use for email deliverability, SPF/DKIM/DMARC, wrangler email setup, MCP email tools, or when a coding agent needs to send emails. Even for simple requests like "add email to my Worker" — this skill has critical config details.
  • cloudflare-one"Guides Cloudflare One Zero Trust and SASE work across Access, Gateway, WARP, Tunnel, Cloudflare WAN, DLP, CASB, device posture, and identity. Use when designing, configuring, troubleshooting, or reviewing Cloudflare One deployments. Retrieval-first: use current Cloudflare docs/API schemas instead of embedded product docs."
  • cloudflare-one-migrationsPlans migrations from Zscaler ZIA/ZPA, Palo Alto, legacy VPN, SWG, or SASE stacks to Cloudflare One. Use for migration assessments, policy mapping, rollout plans, and parity/gap analysis.
  • durable-objectsCreate and review Cloudflare Durable Objects. Use when building stateful coordination (chat rooms, multiplayer games, booking systems), implementing RPC methods, SQLite storage, alarms, WebSockets, or reviewing DO code for best practices. Covers Workers integration, wrangler config, and testing with Vitest. Biases towards retrieval from Cloudflare docs over pre-trained knowledge.
  • sandbox-sdkBuild sandboxed applications for secure code execution. Load when building AI code execution, code interpreters, CI/CD systems, interactive dev environments, or executing untrusted code. Covers Sandbox SDK lifecycle, commands, files, code interpreter, and preview URLs. Biases towards retrieval from Cloudflare docs over pre-trained knowledge.
  • turnstile-spinSet up Cloudflare Turnstile end-to-end in a project. Scan the codebase, create the widget via the Cloudflare API, embed it on the right forms, wire canonical server-side siteverify in the customer's existing backend, validate, and persist the skill. Load this when a user asks to add Turnstile, set up CAPTCHA, protect a form from bots, or fix a Turnstile integration. Mirrors developers.cloudflare.com/turnstile/spin.
  • web-perfAnalyzes web performance using Chrome DevTools MCP. Measures Core Web Vitals (LCP, INP, CLS) and supplementary metrics (FCP, TBT, Speed Index), identifies render-blocking resources, network dependency chains, layout shifts, caching issues, and accessibility gaps. Use when asked to audit, profile, debug, or optimize page load performance, Lighthouse scores, or site speed. Biases towards retrieval from current documentation over pre-trained knowledge.
  • workers-best-practicesReviews and authors Cloudflare Workers code against production best practices. Load when writing new Workers, reviewing Worker code, configuring wrangler.jsonc, or checking for common Workers anti-patterns (streaming, floating promises, global state, secrets, bindings, observability). Biases towards retrieval from Cloudflare docs over pre-trained knowledge.
  • wranglerCloudflare Workers CLI for deploying, developing, and managing Workers, KV, R2, D1, Vectorize, Hyperdrive, Workers AI, Containers, Queues, Workflows, Pipelines, and Secrets Store. Load before running wrangler commands to ensure correct syntax and best practices. Biases towards retrieval from Cloudflare docs over pre-trained knowledge.
MCP servers

Live access to the Cloudflare API, docs, and observability.

MCP servers provide typed tools to call into Cloudflare at runtime. There are two options: Code Mode — a single server that covers the entire Cloudflare API (2,500+ endpoints in ~1,000 tokens) — or a set of focused, domain-specific servers hosted in the cloudflare/mcp-server-cloudflare repo. The full catalog is also in the MCP servers for Cloudflare docs.

  • Code mode APIcode modeBroad access to the full Cloudflare API via code execution, with minimal token overheadhttps://mcp.cloudflare.com/mcp
  • AI Gateway serverSearch your logs, get details about the prompts and responseshttps://ai-gateway.mcp.cloudflare.com/mcp
  • Audit Logs serverQuery audit logs and generate reports for reviewhttps://auditlogs.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
  • Digital Experience Monitoring serverGet quick insight on critical applications for your organizationhttps://dex.mcp.cloudflare.com/mcp
  • DNS Analytics serverOptimize DNS performance and debug issues based on current set uphttps://dns-analytics.mcp.cloudflare.com/mcp
  • Documentation serverGet up to date reference information on Cloudflarehttps://docs.mcp.cloudflare.com/mcp
  • GraphQL serverGet analytics data using Cloudflare’s GraphQL APIhttps://graphql.mcp.cloudflare.com/mcp
  • Logpush serverGet quick summaries for Logpush job healthhttps://logs.mcp.cloudflare.com/mcp
  • Observability serverDebug and get insight into your application's logs and analyticshttps://observability.mcp.cloudflare.com/mcp
  • Workers Bindings serverBuild Workers applications with storage, AI, and compute primitiveshttps://bindings.mcp.cloudflare.com/mcp
  • Workers Builds serverGet insights and manage your Cloudflare Workers Buildshttps://builds.mcp.cloudflare.com/mcp
Wrangler CLI

Local dev, deploys, and Workers-specific commands.

Use Wrangler for local development, deploys, and product-specific commands like wrangler d1 migrations apply or wrangler tail. The bundled wrangler Skill teaches the agent when to reach for it.

Agent-friendly docs

Token-efficient references optimized for agents.

Append /index.md to any Cloudflare docs URL for a clean markdown version. Every top-level product section also has its own llms.txt — a page index sized for a single context window. A few useful ones:

For a full overview of how these docs are structured for agents, refer to the Docs for Agents guide.

示例提示词

技巧与建议

  • 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)

Copilot 是否支持 Cloudflare Skills?

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

我是应该使用 Skills、MCP 服务器、Wrangler CLI,还是全部使用?

全部三者。Skills 将 Cloudflare 专业知识加载到每次 Agent 模式会话中。 Cloudflare API MCP 服务器处理平台操作(DNS、WAF、Zero Trust、R2 bucket)。Wrangler 在 VS Code 终端中运行本地开发 和部署。捆绑的 wrangler Skill 指导 Copilot 何时调用 哪一个。

我是否仍然需要 .github/copilot-instructions.md?

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

Copilot 能否直接部署到 Cloudflare?

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

故障排查

Skills 未在 Copilot 中加载

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

MCP 服务器在 VS Code 中不可用

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

获取到关于 Cloudflare 产品的过时信息

启用 Cloudflare 文档 MCP 服务器 以便 Agent 可以在运行时拉取 最新文档。如果你不想使用 MCP 服务器,可以将 Agent 直接指向 developers.cloudflare.com/llms.txt 以获取每个产品的目录, 或指向 developers.cloudflare.com/<product>/llms.txt 获取特定产品的索引。

在 Cloudflare 上构建 Agent

Also worth knowing

Cloudflare is not just a deploy target for agents, it is a full stack for building your own.

其他 Agent

这篇文档对您有帮助吗?