@cloudflare/agents -> agents-sdk

Author: elithrar

src/content/docs/agents/api-reference/sdk.mdx

@@ -8,12 +8,12 @@ sidebar:
 
 import { MetaInfo, Render, Type, TypeScriptExample, WranglerConfig } from "~/components";
 
-At its most basic, an Agent is a JavaScript class that extends the `Agent` class from the `@cloudflare/agents` package. An Agent encapsulates all of the logic for an Agent, including how clients can connect to it, how it stores state, the methods it exposes, and any error handling.
+At its most basic, an Agent is a JavaScript class that extends the `Agent` class from the `agents-sdk` package. An Agent encapsulates all of the logic for an Agent, including how clients can connect to it, how it stores state, the methods it exposes, and any error handling.
 
 <TypeScriptExample>
 
 ```ts
-import { Agent } from "@cloudflare/agents";
+import { Agent } from "agents-sdk";
 
 class MyAgent extends Agent {
 	// Define methods on the Agent
@@ -30,14 +30,14 @@ Instances of an Agent are addressed by a unique identifier: that identifier (ID)
 
 ## The Agent class
 
-Writing an Agent requires you to define a class that extends the `Agent` class from the `@cloudflare/agents` package. An Agent encapsulates all of the logic for an Agent, including how clients can connect to it, how it stores state, the methods it exposes, and any error handling.
+Writing an Agent requires you to define a class that extends the `Agent` class from the `agents-sdk` package. An Agent encapsulates all of the logic for an Agent, including how clients can connect to it, how it stores state, the methods it exposes, and any error handling.
 
 An Agent has the following class methods:
 
 <TypeScriptExample>
 
 ```ts
-import { Agent } from "@cloudflare/agents";
+import { Agent } from "agents-sdk";
 
 interface Env {
 	// Define environment variables & bindings here
@@ -87,7 +87,7 @@ class MyAgent extends Agent<Env> {
 	}
 
 	// Called when the Agent's state is updated
-	// via this.setState or the useAgent hook from the @cloudflare/agents/react package.
+	// via this.setState or the useAgent hook from the agents-sdk/react package.
 	async onStateUpdate(state: any) {
 		// 'state' will be typed if you supply a type parameter to the Agent class.
 	}
@@ -121,7 +121,7 @@ These three patterns are shown below: we recommend using either `routeAgentReque
 <TypeScriptExample>
 
 ```ts
-import { Agent, AgentNamespace, getAgentByName, routeAgentRequest } from '@cloudflare/agents';
+import { Agent, AgentNamespace, getAgentByName, routeAgentRequest } from 'agents-sdk';
 
 interface Env {
 	// Define your Agent on the environment here
@@ -134,7 +134,7 @@ export default {
 	async fetch(request, env, ctx): Promise<Response> {
 		// Routed addressing
 		// Automatically routes HTTP requests and/or WebSocket connections to /agents/:agent/:name
-		// Best for: connecting React apps directly to Agents using useAgent from @cloudflare/agents/react
+		// Best for: connecting React apps directly to Agents using useAgent from agents-sdk/react
 		(await routeAgentRequest(request, env)) || Response.json({ msg: 'no agent here' }, { status: 404 });
 
 		// Named addressing

src/content/docs/agents/examples/manage-and-sync-state.mdx

@@ -23,7 +23,7 @@ Every Agent has built-in state management capabilities. You can set and update t
 <TypeScriptExample>
 
 ```ts
-import { Agent } from "@cloudflare/agents";
+import { Agent } from "agents-sdk";
 
 export class MyAgent extends Agent {
   // Update state in response to events
@@ -58,7 +58,7 @@ If you're using TypeScript, you can also provide a type for your Agent's state b
 <TypeScriptExample>
 
 ```ts
-import { Agent } from "@cloudflare/agents";
+import { Agent } from "agents-sdk";
 
 interface Env {}
 
@@ -92,15 +92,15 @@ export class MyAgent extends Agent<Env, FlightRecord> {
 
 ### Synchronizing state
 
-Clients can connect to an Agent and stay synchronized with its state using the React hooks provided as part of `@cloudflare/agents/react`.
+Clients can connect to an Agent and stay synchronized with its state using the React hooks provided as part of `agents-sdk/react`.
 
 A React application can call `useAgent` to connect to a named Agent over WebSockets at
 
 <TypeScriptExample>
 
 ```ts
 import { useState } from "react";
-import { useAgent } from "@cloudflare/agents/react";
+import { useAgent } from "agents-sdk/react";
 
 function StateInterface() {
   const [state, setState] = useState({ counter: 0 });

src/content/docs/agents/examples/schedule-tasks.mdx

@@ -18,7 +18,7 @@ You can call `this.schedule` within any method on an Agent, and schedule tens-of
 <TypeScriptExample>
 
 ```ts
-import { Agent } from "@cloudflare/agents"
+import { Agent } from "agents-sdk"
 
 export class SchedulingAgent extends Agent {
 	async onRequest(request) {

src/content/docs/agents/examples/using-ai-models.mdx

@@ -29,7 +29,7 @@ Instead of buffering the entire response, or risking the client disconecting, yo
 <TypeScriptExample file="src/index.ts">
 
 ```ts
-import { Agent } from "@cloudflare/agents"
+import { Agent } from "agents-sdk"
 import { OpenAI } from "openai"
 
 export class MyAgent extends Agent<Env> {
@@ -88,7 +88,7 @@ Workers AI supports streaming responses out-of-the-box by setting `stream: true`
 <TypeScriptExample file="src/index.ts">
 
 ```ts
-import { Agent } from "@cloudflare/agents"
+import { Agent } from "agents-sdk"
 
 interface Env {
 	AI: Ai;
@@ -138,7 +138,7 @@ Model routing allows you to route requests to different AI models based on wheth
 <TypeScriptExample file="src/index.ts">
 
 ```ts
-import { Agent } from "@cloudflare/agents"
+import { Agent } from "agents-sdk"
 
 interface Env {
 	AI: Ai;
@@ -192,7 +192,7 @@ npm install ai @ai-sdk/openai
 <TypeScriptExample file="src/index.ts">
 
 ```ts
-import { Agent } from "@cloudflare/agents"
+import { Agent } from "agents-sdk"
 import { generateText } from 'ai';
 import { openai } from '@ai-sdk/openai';
 
@@ -219,7 +219,7 @@ Agents can stream responses back over HTTP using Server Sent Events (SSE) from w
 <TypeScriptExample file="src/index.ts">
 
 ```ts
-import { Agent } from "@cloudflare/agents"
+import { Agent } from "agents-sdk"
 import { OpenAI } from "openai"
 
 export class MyAgent extends Agent<Env> {

src/content/docs/agents/examples/websockets.mdx

@@ -20,7 +20,7 @@ Here's an example of an Agent that echoes back any message it receives:
 <TypeScriptExample>
 
 ```ts
-import { Agent, Connection } from "@cloudflare/agents";
+import { Agent, Connection } from "agents-sdk";
 
 export class ChatAgent extends Agent {
   async onConnect(connection: Connection, ctx: ConnectionContext) {
@@ -55,12 +55,12 @@ export class ChatAgent extends Agent {
 
 ## Connecting clients
 
-The Agent framework includes a useful helper package for connecting directly to your Agent (or other Agents) from a client application. Import `@cloudflare/agents/client`, create an instance of `AgentClient` and use it to connect to an instance of your Agent:
+The Agent framework includes a useful helper package for connecting directly to your Agent (or other Agents) from a client application. Import `agents-sdk/client`, create an instance of `AgentClient` and use it to connect to an instance of your Agent:
 
 <TypeScriptExample>
 
 ```ts
-import { AgentClient } from "@cloudflare/agents/client";
+import { AgentClient } from "agents-sdk/client";
 
 const connection = new AgentClient({
   agent: "dialogue-agent",
@@ -83,12 +83,12 @@ connection.send(
 
 ## React clients
 
-React-based applications can import `@cloudflare/agents/react` and use the `useAgent` hook to connect to an instance of an Agent directly:
+React-based applications can import `agents-sdk/react` and use the `useAgent` hook to connect to an instance of an Agent directly:
 
 <TypeScriptExample>
 
 ```ts
-import { useAgent } from "@cloudflare/agents/react";
+import { useAgent } from "agents-sdk/react";
 
 function AgentInterface() {
   const connection = useAgent({
@@ -129,7 +129,7 @@ Define `onError` and `onClose` methods on your Agent to explicitly handle WebSoc
 <TypeScriptExample>
 
 ```ts
-import { Agent, Connection } from "@cloudflare/agents";
+import { Agent, Connection } from "agents-sdk";
 
 export class ChatAgent extends Agent {
  	// onConnect and onMessage methods

src/content/docs/agents/getting-started/quick-start.mdx

@@ -57,7 +57,7 @@ Open up `src/index.ts` in your favorite text editor:
 <TypeScriptExample filename="src/index.ts">
 
 ```ts
-import { Agent } from "@cloudflare/agents";
+import { Agent } from "agents-sdk";
 
 export class MyAgent extends Agent {
 

src/content/docs/agents/getting-started/testing-your-agent.mdx

@@ -16,7 +16,7 @@ Because Agents run on Cloudflare Workers and Durable Objects, they can be tested
 
 :::note
 
-The `@cloudflare/agents-starter` template and new Cloudflare Workers projects already include the relevant `vitest` and `@cloudflare/vitest-pool-workers` packages, as well as a valid `vitest.config.js` file.
+The `agents-sdk-starter` template and new Cloudflare Workers projects already include the relevant `vitest` and `@cloudflare/vitest-pool-workers` packages, as well as a valid `vitest.config.js` file.
 
 :::
 

src/content/docs/agents/guides/human-in-the-loop.mdx

@@ -5,5 +5,5 @@ external_link: https://github.com/cloudflare/agents/tree/main/guides/anthropic-p
 sidebar:
   order: 3
 head: []
-description: Implement common agent patterns using the `@cloudflare/agents` framework.
+description: Implement common agent patterns using the `agents-sdk` framework.
 ---