Skip to content

try-works/role-model / .agents/skills/cloudflare

cloudflare

Unverified

Comprehensive 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.

FileKindSize
SKILL.mdskill md8.8 KB
references/agents-sdk/README.mdmarkdown2.7 KB
references/agents-sdk/api.mdmarkdown5.7 KB
references/agents-sdk/configuration.mdmarkdown3.5 KB
references/agents-sdk/gotchas.mdmarkdown5.0 KB
references/agents-sdk/patterns.mdmarkdown5.5 KB
references/ai-gateway/README.mdmarkdown6.2 KB
references/ai-gateway/configuration.mdmarkdown2.9 KB
references/ai-gateway/dynamic-routing.mdmarkdown1.8 KB
references/ai-gateway/features.mdmarkdown2.7 KB
references/ai-gateway/sdk-integration.mdmarkdown2.6 KB
references/ai-gateway/troubleshooting.mdmarkdown2.4 KB
references/ai-search/README.mdmarkdown4.4 KB
references/ai-search/api.mdmarkdown2.5 KB
references/ai-search/configuration.mdmarkdown1.7 KB
references/ai-search/gotchas.mdmarkdown2.1 KB
references/ai-search/patterns.mdmarkdown2.0 KB
references/analytics-engine/README.mdmarkdown3.3 KB
references/analytics-engine/api.mdmarkdown3.1 KB
references/analytics-engine/configuration.mdmarkdown2.3 KB
references/analytics-engine/gotchas.mdmarkdown2.0 KB
references/analytics-engine/patterns.mdmarkdown2.3 KB
references/api-shield/README.mdmarkdown1.8 KB
references/api-shield/api.mdmarkdown3.8 KB
references/api-shield/configuration.mdmarkdown4.9 KB
references/api-shield/gotchas.mdmarkdown4.8 KB
references/api-shield/patterns.mdmarkdown5.7 KB
references/api/README.mdmarkdown2.4 KB
references/api/api.mdmarkdown4.2 KB
references/api/configuration.mdmarkdown3.7 KB
references/api/gotchas.mdmarkdown5.3 KB
references/api/patterns.mdmarkdown4.5 KB
references/argo-smart-routing/README.mdmarkdown4.0 KB
references/argo-smart-routing/api.mdmarkdown6.4 KB
references/argo-smart-routing/configuration.mdmarkdown4.4 KB
references/argo-smart-routing/gotchas.mdmarkdown4.2 KB
references/argo-smart-routing/patterns.mdmarkdown3.0 KB
references/artifacts/README.mdmarkdown3.7 KB
references/artifacts/api.mdmarkdown5.0 KB
references/artifacts/configuration.mdmarkdown3.1 KB
references/bindings/README.mdmarkdown3.9 KB
references/bindings/api.mdmarkdown5.1 KB
references/bindings/configuration.mdmarkdown4.4 KB
references/bindings/gotchas.mdmarkdown6.0 KB
references/bindings/patterns.mdmarkdown4.9 KB
references/bot-management/README.mdmarkdown3.7 KB
references/bot-management/api.mdmarkdown5.7 KB
references/bot-management/configuration.mdmarkdown5.6 KB
references/bot-management/gotchas.mdmarkdown5.5 KB
references/bot-management/patterns.mdmarkdown4.9 KB
references/browser-rendering/README.mdmarkdown3.0 KB
references/browser-rendering/api.mdmarkdown2.9 KB
references/browser-rendering/configuration.mdmarkdown1.8 KB
references/browser-rendering/gotchas.mdmarkdown2.5 KB
references/browser-rendering/patterns.mdmarkdown2.6 KB
references/c3/README.mdmarkdown3.3 KB
references/c3/api.mdmarkdown2.2 KB
references/c3/configuration.mdmarkdown1.6 KB
references/c3/gotchas.mdmarkdown2.3 KB
references/c3/patterns.mdmarkdown2.2 KB
references/cache-reserve/README.mdmarkdown5.5 KB
references/cache-reserve/api.mdmarkdown5.9 KB
references/cache-reserve/configuration.mdmarkdown3.6 KB
references/cache-reserve/gotchas.mdmarkdown5.7 KB
references/cache-reserve/patterns.mdmarkdown6.1 KB
references/containers/README.mdmarkdown3.4 KB
references/containers/api.mdmarkdown4.2 KB
references/containers/configuration.mdmarkdown5.3 KB
references/containers/gotchas.mdmarkdown4.4 KB
references/containers/patterns.mdmarkdown4.8 KB
references/cron-triggers/README.mdmarkdown2.9 KB
references/cron-triggers/api.mdmarkdown5.7 KB
references/cron-triggers/configuration.mdmarkdown4.2 KB
references/cron-triggers/gotchas.mdmarkdown6.2 KB
references/cron-triggers/patterns.mdmarkdown6.8 KB
references/d1/README.mdmarkdown4.6 KB
references/d1/api.mdmarkdown6.6 KB
references/d1/configuration.mdmarkdown5.5 KB
references/d1/gotchas.mdmarkdown4.2 KB
references/d1/patterns.mdmarkdown7.1 KB
references/ddos/README.mdmarkdown2.0 KB
references/ddos/api.mdmarkdown4.1 KB
references/ddos/configuration.mdmarkdown2.9 KB
references/ddos/gotchas.mdmarkdown3.8 KB
references/ddos/patterns.mdmarkdown5.5 KB
references/do-storage/README.mdmarkdown2.7 KB
references/do-storage/api.mdmarkdown3.5 KB
references/do-storage/configuration.mdmarkdown2.2 KB
references/do-storage/gotchas.mdmarkdown5.1 KB
references/do-storage/patterns.mdmarkdown6.0 KB
references/do-storage/testing.mdmarkdown4.8 KB
references/durable-objects/README.mdmarkdown6.5 KB
references/durable-objects/api.mdmarkdown6.0 KB
references/durable-objects/configuration.mdmarkdown4.2 KB
references/durable-objects/gotchas.mdmarkdown7.1 KB
references/durable-objects/patterns.mdmarkdown6.5 KB
references/email-routing/README.mdmarkdown3.4 KB
references/email-routing/api.mdmarkdown5.2 KB
references/email-routing/configuration.mdmarkdown3.5 KB
references/email-routing/gotchas.mdmarkdown4.0 KB
references/email-routing/patterns.mdmarkdown5.4 KB
references/email-workers/README.mdmarkdown5.3 KB
references/email-workers/api.mdmarkdown5.9 KB
references/email-workers/configuration.mdmarkdown2.7 KB
references/email-workers/gotchas.mdmarkdown3.0 KB
references/email-workers/patterns.mdmarkdown2.7 KB
references/flagship/README.mdmarkdown3.6 KB
references/flagship/api.mdmarkdown11.5 KB
references/flagship/configuration.mdmarkdown4.7 KB
references/flagship/gotchas.mdmarkdown6.2 KB
references/flagship/patterns.mdmarkdown13.7 KB
references/graphql-api/README.mdmarkdown7.6 KB
references/graphql-api/api.mdmarkdown5.6 KB
references/graphql-api/configuration.mdmarkdown4.6 KB
references/graphql-api/gotchas.mdmarkdown4.7 KB
references/graphql-api/patterns.mdmarkdown6.4 KB
references/hyperdrive/README.mdmarkdown2.8 KB
references/hyperdrive/api.mdmarkdown3.8 KB
references/hyperdrive/configuration.mdmarkdown3.8 KB
references/hyperdrive/gotchas.mdmarkdown3.8 KB
references/hyperdrive/patterns.mdmarkdown5.8 KB
references/images/README.mdmarkdown2.8 KB
references/images/api.mdmarkdown2.5 KB
references/images/configuration.mdmarkdown4.0 KB
references/images/gotchas.mdmarkdown2.4 KB
references/images/patterns.mdmarkdown3.5 KB
references/kv/README.mdmarkdown2.8 KB
references/kv/api.mdmarkdown4.2 KB
references/kv/configuration.mdmarkdown3.0 KB
references/kv/gotchas.mdmarkdown4.3 KB
references/kv/patterns.mdmarkdown4.6 KB
references/miniflare/README.mdmarkdown2.9 KB
references/miniflare/api.mdmarkdown4.5 KB
references/miniflare/configuration.mdmarkdown3.4 KB
references/miniflare/gotchas.mdmarkdown3.6 KB
references/miniflare/patterns.mdmarkdown4.2 KB
references/network-interconnect/README.mdmarkdown3.2 KB
references/network-interconnect/api.mdmarkdown5.5 KB
references/network-interconnect/configuration.mdmarkdown4.2 KB
references/network-interconnect/gotchas.mdmarkdown5.4 KB
references/network-interconnect/patterns.mdmarkdown3.9 KB
references/observability/README.mdmarkdown3.9 KB
references/observability/api.mdmarkdown3.4 KB
references/observability/configuration.mdmarkdown3.5 KB
references/observability/gotchas.mdmarkdown3.7 KB
references/observability/patterns.mdmarkdown2.4 KB
references/pages-functions/README.mdmarkdown3.2 KB
references/pages-functions/api.mdmarkdown4.6 KB
references/pages-functions/configuration.mdmarkdown2.9 KB
references/pages-functions/gotchas.mdmarkdown3.8 KB
references/pages-functions/patterns.mdmarkdown4.1 KB
references/pages/README.mdmarkdown2.8 KB
references/pages/api.mdmarkdown5.8 KB
references/pages/configuration.mdmarkdown5.7 KB
references/pages/gotchas.mdmarkdown7.9 KB
references/pages/patterns.mdmarkdown5.9 KB
references/pipelines/README.mdmarkdown4.2 KB
references/pipelines/api.mdmarkdown4.9 KB
references/pipelines/configuration.mdmarkdown6.0 KB
references/pipelines/gotchas.mdmarkdown3.0 KB
references/pipelines/patterns.mdmarkdown4.6 KB
references/pulumi/README.mdmarkdown3.2 KB
references/pulumi/api.mdmarkdown5.6 KB
references/pulumi/configuration.mdmarkdown5.5 KB
references/pulumi/gotchas.mdmarkdown6.4 KB
references/pulumi/patterns.mdmarkdown6.8 KB
references/queues/README.mdmarkdown3.0 KB
references/queues/api.mdmarkdown5.4 KB
references/queues/configuration.mdmarkdown3.7 KB
references/queues/gotchas.mdmarkdown7.1 KB
references/queues/patterns.mdmarkdown5.4 KB
references/r2-data-catalog/README.mdmarkdown3.9 KB
references/r2-data-catalog/api.mdmarkdown5.5 KB
references/r2-data-catalog/configuration.mdmarkdown3.9 KB
references/r2-data-catalog/gotchas.mdmarkdown3.2 KB
references/r2-data-catalog/patterns.mdmarkdown5.2 KB
references/r2-sql/README.mdmarkdown3.2 KB
references/r2-sql/api.mdmarkdown4.8 KB
references/r2-sql/configuration.mdmarkdown1.6 KB
references/r2-sql/gotchas.mdmarkdown1.9 KB
references/r2-sql/patterns.mdmarkdown4.3 KB
references/r2/README.mdmarkdown2.8 KB
references/r2/api.mdmarkdown5.5 KB
references/r2/configuration.mdmarkdown3.6 KB
references/r2/gotchas.mdmarkdown4.9 KB
references/r2/patterns.mdmarkdown5.7 KB
references/realtime-sfu/README.mdmarkdown3.0 KB
references/realtime-sfu/api.mdmarkdown3.7 KB
references/realtime-sfu/configuration.mdmarkdown3.4 KB
references/realtime-sfu/gotchas.mdmarkdown4.8 KB
references/realtime-sfu/patterns.mdmarkdown5.3 KB
references/realtimekit/README.mdmarkdown4.0 KB
references/realtimekit/api.mdmarkdown8.2 KB
references/realtimekit/configuration.mdmarkdown5.1 KB
references/realtimekit/gotchas.mdmarkdown6.7 KB
references/realtimekit/patterns.mdmarkdown7.5 KB
references/sandbox/README.mdmarkdown3.0 KB
references/sandbox/api.mdmarkdown4.9 KB
references/sandbox/configuration.mdmarkdown3.3 KB
references/sandbox/gotchas.mdmarkdown5.3 KB

references/agents-sdk/api.md

View on GitHub
# API Reference

## Agent Classes

### AIChatAgent

For AI chat with auto-streaming, message history, tools, resumable streaming.

```ts
import { AIChatAgent } from "@cloudflare/ai-chat";
import { openai } from "@ai-sdk/openai";

export class ChatAgent extends AIChatAgent<Env> {
  async onChatMessage(onFinish) {
    return this.streamText({
      model: openai("gpt-4"),
      messages: this.messages, // Auto-managed message history
      tools: {
        getWeather: {
          description: "Get weather",
          parameters: z.object({ city: z.string() }),
          execute: async ({ city }) => `Sunny, 72°F in ${city}`
        }
      },
      onFinish, // Persist response to this.messages
    });
  }
}
```

### Agent (Base Class)

Full control for custom logic, WebSockets, email, and SQL.

```ts
import { Agent } from "agents";

export class MyAgent extends Agent<Env, State> {
  // Lifecycle methods below
}
```

**Type params:** `Agent<Env, State, ConnState>` - Env bindings, agent state, connection state

## Lifecycle Hooks

```ts
onStart() { // Init/restart
  this.sql`CREATE TABLE IF NOT EXISTS users (id TEXT, name TEXT)`;
}

async onRequest(req: Request) { // HTTP
  const {pathname} = new URL(req.url);
  if (pathname === "/users") return Response.json(this.sql<{id,name}>`SELECT * FROM users`);
  return new Response("Not found", {status: 404});
}

async onConnect(conn: Connection<ConnState>, ctx: ConnectionContext) { // WebSocket
  conn.accept();
  conn.setState({userId: ctx.request.headers.get("X-User-ID")});
  conn.send(JSON.stringify({type: "connected", state: this.state}));
}

async onMessage(conn: Connection<ConnState>, msg: WSMessage) { // WS messages
  const m = JSON.parse(msg as string);
  this.setState({messages: [...this.state.messages, m]});
  this.connections.forEach(c => c.send(JSON.stringify(m)));
}

async onEmail(email: AgentEmail) { // Email routing
  this.sql`INSERT INTO emails (from_addr,subject,body) VALUES (${email.from},${email.headers.get("subject")},${await email.text()})`;
}
```

## State, SQL, Scheduling

```ts
// State
this.setState({count: 42}); // Auto-syncs
this.setState({...this.state, count: this.state.count + 1});

// SQL (parameterized queries prevent injection)
this.sql`CREATE TABLE IF NOT EXISTS users (id TEXT PRIMARY KEY, name TEXT)`;
this.sql`INSERT INTO users (id,name) VALUES (${userId},${name})`;
const users = this.sql<{id,name}>`SELECT * FROM users WHERE id = ${userId}`;

// Scheduling
await this.schedule(new Date("2026-12-25"), "sendGreeting", {msg:"Hi"}); // Date
await this.schedule(60, "checkStatus", {}); // Delay (sec)
await this.schedule("0 0 * * *", "dailyCleanup", {}); // Cron
await this.cancelSchedule(scheduleId);
```

## RPC Methods (@callable)

```ts
import { Agent, callable } from "agents";

export class MyAgent extends Agent<Env> {
  @callable()
  async processTask(input: {text: string}): Promise<{result: string}> {
    return { result: await this.env.AI.run("@cf/meta/llama-3.1-8b-instruct", {prompt: input.text}) };
  }
}
// Client: const result = await agent.processTask({ text: "Hello" });
// Must return JSON-serializable values
```

## Connections & AI

```ts
// Connections (type: Agent<Env, State, ConnState>)
this.connections.forEach(c => c.send(JSON.stringify(msg))); // Broadcast
conn.setState({userId:"123"}); conn.close(1000, "Goodbye");

// Workers AI
const r = await this.env.AI.run("@cf/meta/llama-3.1-8b-instruct", {prompt});

// Manual streaming (prefer AIChatAgent)
const stream = await client.chat.completions.create({model: "gpt-4", messages, stream: true});
for await (const chunk of stream) conn.send(JSON.stringify({chunk: chunk.choices[0].delta.content}));
```

**Type-safe state:** `Agent<Env, State, ConnState>` - third param types `conn.state`

## MCP Integration

Model Context Protocol for exposing tools:

```ts
// Register & use MCP server
await this.mcp.registerServer("github", {
  url: env.MCP_SERVER_URL,
  auth: { type: "oauth", clientId: env.GITHUB_CLIENT_ID, clientSecret: env.GITHUB_CLIENT_SECRET }
});
const tools = await this.mcp.getAITools(["github"]);
return this.streamText({ model: openai("gpt-4"), messages: this.messages, tools, onFinish });
```

## Task Queue

```ts
await this.queue("processVideo", { videoId: "abc123" }); // Add task
const tasks = await this.dequeue(10); // Process up to 10
```

## Context & Cleanup

```ts
const agent = getCurrentAgent<MyAgent>(); // Get current instance
async destroy() { /* cleanup before agent destroyed */ }
```

## AI Integration

```ts
// Workers AI
const r = await this.env.AI.run("@cf/meta/llama-3.1-8b-instruct", {prompt});

// Manual streaming (prefer AIChatAgent for auto-streaming)
const stream = await client.chat.completions.create({model: "gpt-4", messages, stream: true});
for await (const chunk of stream) {
  if (chunk.choices[0]?.delta?.content) conn.send(JSON.stringify({chunk: chunk.choices[0].delta.content}));
}
```

## Client Hooks (React)

```ts
// useAgent() - WebSocket connection + RPC
import { useAgent } from "agents/react";
const agent = useAgent({ agent: "MyAgent", name: "user-123" }); // name for idFromName
const result = await agent.processTask({ text: "Hello" }); // Call @callable methods
// agent.readyState: 0=CONNECTING, 1=OPEN, 2=CLOSING, 3=CLOSED

// useAgentChat() - AI chat UI
import { useAgentChat } from "@cloudflare/ai-chat/react";
const agent = useAgent({ agent: "ChatAgent" });
const { messages, input, handleInputChange, handleSubmit, isLoading, stop, clearHistory } = 
  useAgentChat({ 
    agent, 
    maxSteps: 5,        // Max tool iterations
    resume: true,       // Auto-resume on disconnect
    onToolCall: async (toolCall) => {
      // Client tools (human-in-the-loop)
      if (toolCall.toolName === "confirm") return { ok: window.confirm("Proceed?") };
    }
  });
// status: "ready" | "submitted" | "streaming" | "error"
```
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 470kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 470kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 470kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall