- 首頁
- /Docs for agents
面向 Agent 的文件
AI agent——例如 Cursor、GitHub Copilot 與 Claude Code 等工具——可以回答關於 Cloudflare 產品的問題、產生設定,並代表你呼叫 Cloudflare API。Cloudflare 文件提供 Agent 友善的內容格式、agent skills 與 MCP servers,讓你的 AI agent 可以直接查閱文件並與 Cloudflare 服務互動。
本頁說明可用的方法及其設定方式。
快速入門
以下資源涵蓋將 AI agent 與 Cloudflare 文件搭配使用的不同面向。請從最相關的一項開始:
了解關鍵概念
設定你的 agent
以 Agent 友善格式擷取文件
概念
Agent skills
Agent skills ↗ 是結構化、針對特定任務的指令,AI 工具會依需求載入——例如,某個 skill 可能教你的 agent 如何部署 Cloudflare Worker,或設定 WAF(Web Application Firewall)規則。Skills 為你的 agent 提供原本不具備的 Cloudflare 專屬指令。Cloudflare 在 Cloudflare Skills repository ↗ 中發布涵蓋 Workers、storage、AI、networking、security 等主題的 skills。
每個 agent 都有自己的 skill 安裝方式。安裝說明請參閱 設定你的 agent。
Model Context Protocol (MCP)
Model Context Protocol ↗(MCP)是一個開放標準,定義 AI 工具如何連接外部工具、資料與服務。MCP server 是暴露特定能力的應用程式。當你將 MCP server 連接到 agent 時,agent 就能在工作流程中使用這些能力(例如搜尋文件、建立 DNS 記錄或部署 Workers)。
Cloudflare 提供受管的遠端 MCP servers,讓你的 agent 在運作時能夠搜尋文件、呼叫 Cloudflare API,以及查詢 logs 與 analytics。
有兩種方式:
- Cloudflare API MCP server:一個涵蓋整個 Cloudflare API(超過 2,500 個 endpoints)的 Code Mode server。當你的 agent 需要廣泛存取多個 Cloudflare 產品時,請使用此 server。
- Domain-specific servers:針對文件、observability、DNS analytics 等用途的聚焦 servers。當你的 agent 只需要存取特定領域時,請使用這些 servers。完整目錄位於 cloudflare/mcp-server-cloudflare ↗ repository。
每個 agent 的 設定你的 agent 指南都將 MCP server 安裝納入其 Quick start。可用 MCP servers 的完整清單,請參閱 MCP servers for Cloudflare。
模型彈性
AI agents 使用大型語言模型(large language models,LLMs)來理解你的請求並產生回應。模型會影響回應品質、速度與成本。你可以選擇多少種模型取決於 agent:
- Locked(鎖定):僅支援供應商自家的模型。
- BYOK(Bring Your Own Key,自帶金鑰):你為所選的模型供應商提供自己的 API key。
- Multi-provider(多供應商):開箱即支援多個模型供應商。
Context 方法
agent 在多次對話之間如何保留你專案的資訊,會影響你的 agent 在 session 之間記住多少內容:
- Project memory(專案記憶):agent 使用儲存的檔案或記憶,跨 session 記住 context。
- Indexed codebase(已建立索引的程式碼庫):agent 為你的 repository 建立可搜尋的索引,以便快速查詢。
設定你的 agent
每個受支援的 agent 都有專屬的設定指南,涵蓋安裝、skills、MCP server 設定、prompt 範例、提示與疑難排解。
供 LLM 使用的 Markdown 文件
AI 工具使用 Markdown 的效果優於 HTML,因為 Markdown 的明確結構比 HTML tags 有更少的額外負擔,可減少浪費的 tokens(AI 模型處理的文字單位),並產生更好的結果。
每個文件頁面都可以透過下列任一種方法取得 Markdown 格式,由 Markdown for Agents 提供支援。
從目前頁面複製
在任何文件頁面上,選取 Copy as Markdown 即可將目前頁面複製為 Markdown。
在 URL 後方加上 /index.md
在任何頁面 URL 的結尾加上 /index.md。例如:
https://developers.cloudflare.com/workers/get-started/index.md 傳送 Accept: text/markdown header[](#send-an-accept-textmarkdown-header) 使用 Accept: text/markdown header 請求任何頁面,此 header 會告訴伺服器你偏好 Markdown 而非 HTML:
curl "https://developers.cloudflare.com/workers/get-started/" \ --header "Accept: text/markdown" 回應中包含 x-markdown-tokens 與 x-original-tokens headers,帶有 Markdown 文件與原始 HTML 文件的估計 token 數量,對於 context window 規劃很有用(context window 是 AI 模型一次能考慮的最大 token 數量)。
全站 endpoints
這些 endpoints 遵循 llms.txt standard ↗,並以 Markdown 格式提供文件內容:
| Endpoint | Description |
|---|---|
| /llms.txt | 依產品類別分組的頁面索引,內含各產品自身 llms.txt 的連結 |
| /llms-full.txt | 所有文件的完整內容彙整於單一檔案,適用於離線索引、批次 vectorization(將內容轉換為數值表示以進行相似度搜尋)或 large-context models |
各產品 endpoints
每個產品都有各自的 llms.txt 與 llms-full.txt。當你只需要特定產品的文件時,請使用這些檔案。
| Endpoint | Description |
|---|---|
| /workers/llms.txt | Workers 文件的頁面索引 |
| /workers/llms-full.txt | 所有 Workers 文件頁面的完整內容 |
將 /workers/ 替換為任何產品路徑。可用產品的完整清單,請參閱 /llms.txt。
OpenAPI 規格
OpenAPI specification ↗ 是 API 的機器可讀描述——它列出每個可用的 endpoint、每個 endpoint 接受的參數,以及其回傳的回應。當你將它加入 AI 工具的 context 時,工具就能產生對 Cloudflare 服務的 API 呼叫,而不需要你手動查閱文件。
完整的 Cloudflare API OpenAPI specification 可供 AI 程式設計工具、API clients 與程式碼產生器使用:
| Endpoint | Description |
|---|---|
| cloudflare/api-schemas ↗ | 完整的 Cloudflare API OpenAPI specification(JSON) |
完整的 API 參考,請參閱 Cloudflare API documentation。
這對你有幫助嗎?