跳转到内容
搜索文档

面向 Agent 的文档

最后更新 查看 MarkdownAgent 设置

AI agent(诸如 Cursor、GitHub Copilot 和 Claude Code 等工具)能够回答有关 Cloudflare 产品的问题、生成配置,并代表你调用 Cloudflare API。Cloudflare 文档以 Agent 友好格式、Agent 技能 (skills) 和 MCP 服务器的形式提供内容,以便你的 AI agent 能够查阅文档并直接与 Cloudflare 服务进行交互。

本页面解释了可用的方法以及如何对其进行设置。

快速入门

这些资源涵盖了结合 Cloudflare 文档使用 AI agent 的不同方面。从与你最相关的部分开始:

概念

Agent 技能 (Agent skills)

Agent 技能 是结构化的、特定任务的指令,AI 工具会根据需要加载这些指令——例如,某项 skill 可能会教导你的 Agent 如何部署 Cloudflare Worker 或配置 WAF(Web 应用程序防火墙)规则。Skills 为你的 Agent 提供了它原本不具备的特定于 Cloudflare 的指令。Cloudflare 在 Cloudflare Skills 仓库 中发布了涵盖 Workers、存储、AI、网络、安全等领域的 skills。

每个 Agent 都有其专有的 skills 安装方法。有关安装说明,请参阅设置你的 Agent

模型上下文协议 (Model Context Protocol - MCP)

Model Context Protocol (MCP) 是一个开放标准,定义了 AI 工具如何连接到外部工具、数据和服务。MCP 服务器是公开特定能力的应用程序。当你将一个 MCP 服务器连接到你的 Agent 时,Agent 可以在其工作流中组合使用这些能力(例如搜索文档、创建 DNS 记录或部署 Workers)。

Cloudflare 运行着托管的远程 MCP 服务器,使你的 Agent 在工作时具备搜索文档、调用 Cloudflare API 以及查询日志和分析数据的能力。

有两种方式:

  • Cloudflare API MCP 服务器:一个涵盖整个 Cloudflare API(超过 2,500 个端点)的代码模式服务器。当你的 Agent 需要对多个 Cloudflare 产品进行广泛访问时使用。
  • 特定领域服务器:面向文档、可观测性、DNS 分析等领域的专属服务器。当你的 Agent 仅需要访问特定领域时使用。完整的目录位于 cloudflare/mcp-server-cloudflare 仓库中。

每个 Agent 的设置你的 Agent 指南均将 MCP 服务器安装包含在其快速入门部分中。有关可用 MCP 服务器的完整列表,请参阅 面向 Cloudflare 的 MCP 服务器

模型灵活性

AI agent 使用大语言模型 (LLM) 来理解你的请求并生成回复。模型影响回复的质量、速度和成本。你可以选择多少个模型取决于 Agent 本身:

  • 锁定:仅支持厂商自己的模型。
  • BYOK (自带密钥 - Bring Your Own Key):你为你选择的模型提供商提供自己的 API 密钥。
  • 多提供商:开箱即用支持多个模型提供商。

上下文方式

Agent 如何在对话之间保留关于你项目的信息,会影响 Agent 在会话间能记住多少内容:

  • 项目记忆:Agent 使用存储的文件或记忆跨会话记住上下文。
  • 已索引代码库:Agent 针对你的代码库构建可搜索的索引以实现快速查找。

设置你的 Agent

每个受支持的 Agent 都有一个专属的设置指南,涵盖安装、skills、MCP 服务器配置、示例提示词、技巧以及故障排除。

开始使用

面向 LLM 的 Markdown 文档

AI 工具在配合 Markdown 时表现比 HTML 更好,因为 Markdown 显式的结构相比 HTML 标签开销更小,从而减少了消耗的 Token(AI 模型处理文本的单位)并产生更好的结果。

通过由 Markdown for Agents 驱动的以下任一方法,每个文档页面均可作为 Markdown 获取。

从当前页面复制

在任何文档页面上,选择 **Copy as Markdown(复制为 Markdown)**以将当前页面作为 Markdown 复制。

在 URL 末尾追加 /index.md

在任何页面 URL 的末尾添加 /index.md。例如:

https://developers.cloudflare.com/workers/get-started/index.md

发送 Accept: text/markdown 标头

使用 Accept: text/markdown 标头请求任何页面,该标头告诉服务器你倾向于获取 Markdown 而不是 HTML:

curl "https://developers.cloudflare.com/workers/get-started/" \
  --header "Accept: text/markdown"

响应包含 x-markdown-tokensx-original-tokens 标头,带有 Markdown 文档和原始 HTML 文档的估计 Token 数量,这有助于上下文窗口规划(上下文窗口是 AI 模型能一次性处理的最大 Token 数量)。

全站端点

这些端点遵循 llms.txt 标准 并提供 Markdown 格式的文档内容:

端点 描述
/llms.txt 按产品分类分组的页面索引,带有指向每个产品独立 llms.txt 的链接
/llms-full.txt 单个文件中的所有文档完整内容,用于离线索引、批量向量化(将内容转换为数值表示以进行相似度搜索)或大上下文模型

按产品端点

每个产品都有其专有的作用域 llms.txtllms-full.txt。当你仅需要特定产品的文档时使用这些端点。

端点 描述
/workers/llms.txt Workers 文档的页面索引
/workers/llms-full.txt 所有 Workers 文档页面的完整内容

/workers/ 替换为任何产品路径。有关可用产品的完整列表,请参阅 /llms.txt

OpenAPI 规范

OpenAPI 规范 是 API 的机器可读描述——它列出了每个可用端点、每个端点接受的参数以及返回的响应。当你将其添加到 AI 工具的上下文时,该工具无需你手动查找文档即可为 Cloudflare 服务生成 API 调用。

完整的 Cloudflare API OpenAPI 规范适用于 AI 编码工具、API 客户端和代码生成器:

端点 描述
cloudflare/api-schemas 完整的 Cloudflare API OpenAPI 规范 (JSON)

有关完整 API 参考,请参阅 Cloudflare API 文档

这篇文档对您有帮助吗?