Cloudflare Agents SDK
Your knowledge of the Agents SDK may be outdated. Prefer retrieval over pre-training for any Agents SDK task.
Retrieval Sources
Cloudflare docs: https://developers.cloudflare.com/agents/
| Topic |
Docs URL |
Use for |
| Getting started |
Quick start |
First agent, project setup |
| Adding to existing project |
Add to existing project |
Install into existing Workers app |
| Configuration |
Configuration |
wrangler.jsonc, bindings, assets, deployment |
| Agent class |
Agents API |
Agent lifecycle, patterns, pitfalls |
| State |
Store and sync state |
setState, validateStateChange, persistence |
| Routing |
Routing |
URL patterns, routeAgentRequest |
| Callable methods |
Callable methods |
@callable, RPC, streaming, timeouts |
| Scheduling |
Schedule tasks |
schedule(), scheduleEvery(), cron |
| Workflows |
Run workflows |
AgentWorkflow, durable multi-step tasks |
| HTTP/WebSockets |
WebSockets |
Lifecycle hooks, hibernation |
| Chat agents |
Chat agents |
AIChatAgent, streaming, tools, persistence |
| Client SDK |
Client SDK |
useAgent, AgentClient, state, RPC, HTTP |
| Client tools |
Client tools |
Client-side tools, autoContinueAfterToolResult |
| Server-driven messages |
Autonomous responses |
saveMessages, waitUntilStable, server-initiated turns |
| Resumable streaming |
Chat agents |
Stream recovery on disconnect |
| Email |
Email |
Email routing, secure reply resolver |
| MCP client |
MCP client |
Connecting to MCP servers |
| MCP server |
MCP server |
Building MCP servers with createMcpHandler |
| MCP transports |
MCP transports |
Streamable HTTP, SSE, RPC transport options |
| Securing MCP servers |
Securing MCP |
OAuth, proxy MCP, hardening |
| Human-in-the-loop |
Human-in-the-loop |
Workflow approvals, elicitation, timeout handling |
| Durable execution |
Durable execution |
runFiber(), stash(), surviving DO eviction |
| Queue |
Queue |
Built-in FIFO queue, queue() |
| Retries |
Retries |
this.retry(), backoff/jitter |
| Observability |
Observability |
Diagnostics-channel events |
| Push notifications |
Push notifications |
Web Push + VAPID from agents |
| Webhooks |
Webhooks |
Receiving external webhooks |
| Cross-domain auth |
Cross-domain auth |
WebSocket auth, tokens, CORS |
| Readonly connections |
Readonly |
shouldConnectionBeReadonly |
| Voice |
Voice |
Experimental STT/TTS, withVoice |
| Browse the web |
Browser tools |
Experimental CDP browser automation |
| Think |
Think |
Experimental higher-level chat agent class |
| Migrations |
AI SDK v5, AI SDK v6 |
Upgrading @cloudflare/ai-chat |
Capabilities
The Agents SDK provides:
- Persistent state — SQLite-backed, auto-synced to clients via
setState
- Callable RPC —
@callable() methods invoked over WebSocket
- Scheduling — One-time, recurring (
scheduleEvery), and cron tasks
- Workflows — Durable multi-step background processing via
AgentWorkflow
- Durable execution —
runFiber() / stash() for work that survives DO eviction
- Queue — Built-in FIFO queue with retries via
queue()
- Retries —
this.retry() with exponential backoff and jitter
- MCP integration — Connect to MCP servers or build your own with
createMcpHandler
- Email handling — Receive and reply to emails with secure routing
- Streaming chat —
AIChatAgent with resumable streams, message persistence, tools
- Server-driven messages —
saveMessages, waitUntilStable for proactive agent turns
- React hooks —
useAgent, useAgentChat for client apps
- Observability —
diagnostics_channel events for state, RPC, schedule, lifecycle
- Push notifications — Web Push + VAPID delivery from agents
- Webhooks — Receive and verify external webhooks
- Voice (experimental) — STT/TTS via
@cloudflare/voice
- Browser tools (experimental) — CDP-powered browsing via
agents/browser
- Think (experimental) — Higher-level chat agent via
@cloudflare/think
FIRST: Verify Installation
npm ls agents # Should show agents package
If not installed:
npm install agents
For chat agents:
npm install agents @cloudflare/ai-chat ai @ai-sdk/react
Wrangler Configuration
{
"compatibility_flags": ["nodejs_compat"],
"durable_objects": {
"bindings": [{ "name": "MyAgent", "class_name": "MyAgent" }]
},
"migrations": [{ "tag": "v1", "new_sqlite_classes": ["MyAgent"] }]
}
Gotchas:
- Do NOT enable
experimentalDecorators in tsconfig (breaks @callable)
- Never edit old migrations — always add new tags
- Each agent class needs its own DO binding + migration entry
- Add
"ai": { "binding": "AI" } for Workers AI
Agent Class
import { Agent, routeAgentRequest, callable } from "agents";
type State = { count: number };
export class Counter extends Agent<Env, State> {
initialState = { count: 0 };
validateStateChange(nextState: State, source: Connection | "server") {
if (nextState.count < 0) throw new Error("Count cannot be negative");
}
onStateUpdate(state: State, source: Connection | "server") {
console.log("State updated:", state);
}
@callable()
increment() {
this.setState({ count: this.state.count + 1 });
return this.state.count;
}
}
export default {
fetch: (req, env) => routeAgentRequest(req, env) ?? new Response("Not found", { status: 404 })
};
Routing
Requests route to /agents/{agent-name}/{instance-name}:
| Class |
URL |
Counter |
/agents/counter/user-123 |
ChatRoom |
/agents/chat-room/lobby |
Client: useAgent({ agent: "Counter", name: "user-123" })
Custom routing: use getAgentByName(env.MyAgent, "instance-id") then agent.fetch(request).
Core APIs
| Task |
API |
| Read state |
this.state.count |
| Write state |
this.setState({ count: 1 }) |
| SQL query |
this.sql`SELECT * FROM users WHERE id = ${id}` |
| Schedule (delay) |
await this.schedule(60, "task", payload) |
| Schedule (cron) |
await this.schedule("0 * * * *", "task", payload) |
| Schedule (interval) |
await this.scheduleEvery(30, "poll") |
| RPC method |
@callable() myMethod() { ... } |
| Streaming RPC |
@callable({ streaming: true }) stream(res) { ... } |
| Start workflow |
await this.runWorkflow("ProcessingWorkflow", params) |
| Durable fiber |
await this.runFiber("name", async (ctx) => { ... }) |
| Enqueue work |
this.queue("handler", payload) |
| Retry with backoff |
await this.retry(fn, { maxAttempts: 5 }) |
| Broadcast to clients |
this.broadcast(message) |
| Get connections |
this.getConnections(tag?) |
React Client
Read client-sdk.md for client selection and current connection examples. For chat UI and tools, also read streaming-chat.md.
References
Core
- references/state-scheduling.md — State persistence, scheduling, SQL
- references/callable.md — RPC methods, streaming, timeouts
- references/routing.md — URL patterns, custom routing,
getAgentByName
- references/configuration.md — Wrangler config, bindings, Vite setup
Chat & Streaming
- references/streaming-chat.md — AIChatAgent, resumable streams, tools
- references/client-sdk.md —
useAgent, useAgentChat, AgentClient
- references/server-driven-messages.md — Trigger patterns,
saveMessages
- references/human-in-the-loop.md — Approval flows,
needsApproval
Background Processing
- references/workflows.md — Durable Workflows integration
- references/durable-execution.md —
runFiber, stash, surviving eviction
- references/queue-retries.md — Built-in queue, retry with backoff
Integrations
- references/mcp.md — MCP client and server, transports, securing
- references/email.md — Email routing and handling
- references/webhooks-push.md — Webhooks, push notifications
- references/observability.md — Diagnostics-channel events
Experimental
- references/think.md —
@cloudflare/think higher-level chat agent
- references/voice.md —
@cloudflare/voice STT/TTS
- references/codemode.md — Code Mode for tool orchestration
- references/browse-the-web.md — CDP browser tools
1---2name: agents-sdk3description: Build, debug, or review Cloudflare Agents SDK applications using the agents package.4license: Apache-2.05---67# Cloudflare Agents SDK89Your knowledge of the Agents SDK may be outdated. **Prefer retrieval over pre-training** for any Agents SDK task.1011## Retrieval Sources1213Cloudflare docs: https://developers.cloudflare.com/agents/1415| Topic | Docs URL | Use for |16|-------|----------|---------|17| Getting started | [Quick start](https://developers.cloudflare.com/agents/getting-started/quick-start/) | First agent, project setup |18| Adding to existing project | [Add to existing project](https://developers.cloudflare.com/agents/getting-started/add-to-existing-project/) | Install into existing Workers app |19| Configuration | [Configuration](https://developers.cloudflare.com/agents/api-reference/configuration/) | `wrangler.jsonc`, bindings, assets, deployment |20| Agent class | [Agents API](https://developers.cloudflare.com/agents/api-reference/agents-api/) | Agent lifecycle, patterns, pitfalls |21| State | [Store and sync state](https://developers.cloudflare.com/agents/api-reference/store-and-sync-state/) | `setState`, `validateStateChange`, persistence |22| Routing | [Routing](https://developers.cloudflare.com/agents/api-reference/routing/) | URL patterns, `routeAgentRequest` |23| Callable methods | [Callable methods](https://developers.cloudflare.com/agents/api-reference/callable-methods/) | `@callable`, RPC, streaming, timeouts |24| Scheduling | [Schedule tasks](https://developers.cloudflare.com/agents/api-reference/schedule-tasks/) | `schedule()`, `scheduleEvery()`, cron |25| Workflows | [Run workflows](https://developers.cloudflare.com/agents/api-reference/run-workflows/) | `AgentWorkflow`, durable multi-step tasks |26| HTTP/WebSockets | [WebSockets](https://developers.cloudflare.com/agents/api-reference/websockets/) | Lifecycle hooks, hibernation |27| Chat agents | [Chat agents](https://developers.cloudflare.com/agents/communication-channels/chat/chat-agents/) | `AIChatAgent`, streaming, tools, persistence |28| Client SDK | [Client SDK](https://developers.cloudflare.com/agents/communication-channels/chat/client-sdk/) | `useAgent`, `AgentClient`, state, RPC, HTTP |29| Client tools | [Client tools](https://developers.cloudflare.com/agents/harnesses/think/client-tools/) | Client-side tools, `autoContinueAfterToolResult` |30| Server-driven messages | [Autonomous responses](https://developers.cloudflare.com/agents/communication-channels/chat/autonomous-responses/) | `saveMessages`, `waitUntilStable`, server-initiated turns |31| Resumable streaming | [Chat agents](https://developers.cloudflare.com/agents/communication-channels/chat/chat-agents/#resumable-streaming) | Stream recovery on disconnect |32| Email | [Email](https://developers.cloudflare.com/agents/api-reference/email/) | Email routing, secure reply resolver |33| MCP client | [MCP client](https://developers.cloudflare.com/agents/model-context-protocol/apis/client-api/) | Connecting to MCP servers |34| MCP server | [MCP server](https://developers.cloudflare.com/agents/model-context-protocol/apis/handler-api/) | Building MCP servers with `createMcpHandler` |35| MCP transports | [MCP transports](https://developers.cloudflare.com/agents/model-context-protocol/protocol/transport/) | Streamable HTTP, SSE, RPC transport options |36| Securing MCP servers | [Securing MCP](https://developers.cloudflare.com/agents/model-context-protocol/guides/securing-mcp-server/) | OAuth, proxy MCP, hardening |37| Human-in-the-loop | [Human-in-the-loop](https://developers.cloudflare.com/agents/concepts/agentic-patterns/human-in-the-loop/) | Workflow approvals, elicitation, timeout handling |38| Durable execution | [Durable execution](https://developers.cloudflare.com/agents/api-reference/durable-execution/) | `runFiber()`, `stash()`, surviving DO eviction |39| Queue | [Queue](https://developers.cloudflare.com/agents/api-reference/queue-tasks/) | Built-in FIFO queue, `queue()` |40| Retries | [Retries](https://developers.cloudflare.com/agents/api-reference/retries/) | `this.retry()`, backoff/jitter |41| Observability | [Observability](https://developers.cloudflare.com/agents/api-reference/observability/) | Diagnostics-channel events |42| Push notifications | [Push notifications](https://developers.cloudflare.com/agents/communication-channels/webhooks/push-notifications/) | Web Push + VAPID from agents |43| Webhooks | [Webhooks](https://developers.cloudflare.com/agents/communication-channels/webhooks/) | Receiving external webhooks |44| Cross-domain auth | [Cross-domain auth](https://developers.cloudflare.com/agents/runtime/operations/cross-domain-authentication/) | WebSocket auth, tokens, CORS |45| Readonly connections | [Readonly](https://developers.cloudflare.com/agents/api-reference/readonly-connections/) | `shouldConnectionBeReadonly` |46| Voice | [Voice](https://developers.cloudflare.com/agents/api-reference/voice/) | Experimental STT/TTS, `withVoice` |47| Browse the web | [Browser tools](https://developers.cloudflare.com/agents/api-reference/browse-the-web/) | Experimental CDP browser automation |48| Think | [Think](https://developers.cloudflare.com/agents/api-reference/think/) | Experimental higher-level chat agent class |49| Migrations | [AI SDK v5](https://github.com/cloudflare/agents/blob/main/docs/agents/migration-to-ai-sdk-v5.md), [AI SDK v6](https://github.com/cloudflare/agents/blob/main/docs/agents/migration-to-ai-sdk-v6.md) | Upgrading `@cloudflare/ai-chat` |5051## Capabilities5253The Agents SDK provides:5455- **Persistent state** — SQLite-backed, auto-synced to clients via `setState`56- **Callable RPC** — `@callable()` methods invoked over WebSocket57- **Scheduling** — One-time, recurring (`scheduleEvery`), and cron tasks58- **Workflows** — Durable multi-step background processing via `AgentWorkflow`59- **Durable execution** — `runFiber()` / `stash()` for work that survives DO eviction60- **Queue** — Built-in FIFO queue with retries via `queue()`61- **Retries** — `this.retry()` with exponential backoff and jitter62- **MCP integration** — Connect to MCP servers or build your own with `createMcpHandler`63- **Email handling** — Receive and reply to emails with secure routing64- **Streaming chat** — `AIChatAgent` with resumable streams, message persistence, tools65- **Server-driven messages** — `saveMessages`, `waitUntilStable` for proactive agent turns66- **React hooks** — `useAgent`, `useAgentChat` for client apps67- **Observability** — `diagnostics_channel` events for state, RPC, schedule, lifecycle68- **Push notifications** — Web Push + VAPID delivery from agents69- **Webhooks** — Receive and verify external webhooks70- **Voice** (experimental) — STT/TTS via `@cloudflare/voice`71- **Browser tools** (experimental) — CDP-powered browsing via `agents/browser`72- **Think** (experimental) — Higher-level chat agent via `@cloudflare/think`7374## FIRST: Verify Installation7576```bash77npm ls agents # Should show agents package78```7980If not installed:81```bash82npm install agents83```8485For chat agents:86```bash87npm install agents @cloudflare/ai-chat ai @ai-sdk/react88```8990## Wrangler Configuration9192```jsonc93{94 "compatibility_flags": ["nodejs_compat"],95 "durable_objects": {96 "bindings": [{ "name": "MyAgent", "class_name": "MyAgent" }]97 },98 "migrations": [{ "tag": "v1", "new_sqlite_classes": ["MyAgent"] }]99}100```101102**Gotchas:**103- Do NOT enable `experimentalDecorators` in tsconfig (breaks `@callable`)104- Never edit old migrations — always add new tags105- Each agent class needs its own DO binding + migration entry106- Add `"ai": { "binding": "AI" }` for Workers AI107108## Agent Class109110```typescript111import { Agent, routeAgentRequest, callable } from "agents";112113type State = { count: number };114115export class Counter extends Agent<Env, State> {116 initialState = { count: 0 };117118 validateStateChange(nextState: State, source: Connection | "server") {119 if (nextState.count < 0) throw new Error("Count cannot be negative");120 }121122 onStateUpdate(state: State, source: Connection | "server") {123 console.log("State updated:", state);124 }125126 @callable()127 increment() {128 this.setState({ count: this.state.count + 1 });129 return this.state.count;130 }131}132133export default {134 fetch: (req, env) => routeAgentRequest(req, env) ?? new Response("Not found", { status: 404 })135};136```137138## Routing139140Requests route to `/agents/{agent-name}/{instance-name}`:141142| Class | URL |143|-------|-----|144| `Counter` | `/agents/counter/user-123` |145| `ChatRoom` | `/agents/chat-room/lobby` |146147Client: `useAgent({ agent: "Counter", name: "user-123" })`148149Custom routing: use `getAgentByName(env.MyAgent, "instance-id")` then `agent.fetch(request)`.150151## Core APIs152153| Task | API |154|------|-----|155| Read state | `this.state.count` |156| Write state | `this.setState({ count: 1 })` |157| SQL query | `` this.sql`SELECT * FROM users WHERE id = ${id}` `` |158| Schedule (delay) | `await this.schedule(60, "task", payload)` |159| Schedule (cron) | `await this.schedule("0 * * * *", "task", payload)` |160| Schedule (interval) | `await this.scheduleEvery(30, "poll")` |161| RPC method | `@callable() myMethod() { ... }` |162| Streaming RPC | `@callable({ streaming: true }) stream(res) { ... }` |163| Start workflow | `await this.runWorkflow("ProcessingWorkflow", params)` |164| Durable fiber | `await this.runFiber("name", async (ctx) => { ... })` |165| Enqueue work | `this.queue("handler", payload)` |166| Retry with backoff | `await this.retry(fn, { maxAttempts: 5 })` |167| Broadcast to clients | `this.broadcast(message)` |168| Get connections | `this.getConnections(tag?)` |169170## React Client171172Read [client-sdk.md](references/client-sdk.md) for client selection and current connection examples. For chat UI and tools, also read [streaming-chat.md](references/streaming-chat.md).173174## References175176### Core177- **[references/state-scheduling.md](references/state-scheduling.md)** — State persistence, scheduling, SQL178- **[references/callable.md](references/callable.md)** — RPC methods, streaming, timeouts179- **[references/routing.md](references/routing.md)** — URL patterns, custom routing, `getAgentByName`180- **[references/configuration.md](references/configuration.md)** — Wrangler config, bindings, Vite setup181182### Chat & Streaming183- **[references/streaming-chat.md](references/streaming-chat.md)** — AIChatAgent, resumable streams, tools184- **[references/client-sdk.md](references/client-sdk.md)** — `useAgent`, `useAgentChat`, `AgentClient`185- **[references/server-driven-messages.md](references/server-driven-messages.md)** — Trigger patterns, `saveMessages`186- **[references/human-in-the-loop.md](references/human-in-the-loop.md)** — Approval flows, `needsApproval`187188### Background Processing189- **[references/workflows.md](references/workflows.md)** — Durable Workflows integration190- **[references/durable-execution.md](references/durable-execution.md)** — `runFiber`, `stash`, surviving eviction191- **[references/queue-retries.md](references/queue-retries.md)** — Built-in queue, retry with backoff192193### Integrations194- **[references/mcp.md](references/mcp.md)** — MCP client and server, transports, securing195- **[references/email.md](references/email.md)** — Email routing and handling196- **[references/webhooks-push.md](references/webhooks-push.md)** — Webhooks, push notifications197- **[references/observability.md](references/observability.md)** — Diagnostics-channel events198199### Experimental200- **[references/think.md](references/think.md)** — `@cloudflare/think` higher-level chat agent201- **[references/voice.md](references/voice.md)** — `@cloudflare/voice` STT/TTS202- **[references/codemode.md](references/codemode.md)** — Code Mode for tool orchestration203- **[references/browse-the-web.md](references/browse-the-web.md)** — CDP browser tools