Skip to content

[Agents] Move the Agent class docs under /agents/agent-class/ #33974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattzcarey merged 2 commits into from
Oct 27, 2026
Merged

[Agents] Move the Agent class docs under /agents/agent-class/ #33974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53d1651
[Agents] Move the Agent class docs under /agents/agent-class/
mattzcarey Oct 27, 2026
c1c13d1
[Agents] Address style review: relative links, refer to, serial comma…
mattzcarey Oct 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 72 additions & 43 deletions public/__redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,69 +240,98 @@
/aegis/analytics/ /smart-shield/configuration/dedicated-egress-ips/ips-utilization/ 301

# agents
/agents/communication-channels/ /agents/agent-class/communication-channels/ 301
/agents/communication-channels/chat/ /agents/agent-class/communication-channels/chat/ 301
/agents/communication-channels/chat/autonomous-responses/ /agents/agent-class/communication-channels/chat/autonomous-responses/ 301
/agents/communication-channels/chat/chat-agents/ /agents/agent-class/communication-channels/chat/chat-agents/ 301
/agents/communication-channels/chat/client-sdk/ /agents/agent-class/communication-channels/chat/client-sdk/ 301
/agents/communication-channels/email/ /agents/agent-class/communication-channels/email/ 301
/agents/communication-channels/slack/ /agents/agent-class/communication-channels/slack/ 301
/agents/communication-channels/voice/ /agents/agent-class/communication-channels/voice/ 301
/agents/communication-channels/webhooks/ /agents/agent-class/communication-channels/webhooks/ 301
/agents/communication-channels/webhooks/push-notifications/ /agents/agent-class/communication-channels/webhooks/push-notifications/ 301
/agents/runtime/agents-api/ /agents/agent-class/ 301
/agents/runtime/communication/ /agents/agent-class/ 301
/agents/runtime/communication/chat-sdk/ /agents/agent-class/communication-channels/chat-sdk/ 301
/agents/runtime/communication/http-sse/ /agents/agent-class/http-sse/ 301
/agents/runtime/communication/protocol-messages/ /agents/agent-class/protocol-messages/ 301
/agents/runtime/communication/readonly-connections/ /agents/agent-class/readonly-connections/ 301
/agents/runtime/communication/routing/ /agents/agent-class/routing/ 301
/agents/runtime/communication/websockets/ /agents/agent-class/websockets/ 301
/agents/runtime/execution/agent-tools/ /agents/agent-class/agent-tools/ 301
/agents/runtime/execution/durable-execution/ /agents/agent-class/durable-execution/ 301
/agents/runtime/execution/queue-tasks/ /agents/agent-class/queue-tasks/ 301
/agents/runtime/execution/retries/ /agents/agent-class/retries/ 301
/agents/runtime/execution/run-workflows/ /agents/agent-class/run-workflows/ 301
/agents/runtime/execution/schedule-tasks/ /agents/agent-class/schedule-tasks/ 301
/agents/runtime/execution/sub-agents/ /agents/agent-class/sub-agents/ 301
/agents/runtime/lifecycle/agent-class/ /agents/agent-class/internals/ 301
/agents/runtime/lifecycle/callable-methods/ /agents/agent-class/callable-methods/ 301
/agents/runtime/lifecycle/state/ /agents/agent-class/state/ 301
/agents/runtime/operations/using-ai-models/ /agents/agent-class/using-ai-models/ 301
/agents/api-reference/think/ /agents/harnesses/think/ 301
/agents/think/ /agents/harnesses/think/ 301
/agents/build/prompts/ /workers/get-started/prompting/ 301
/agents/getting-started/build-a-chat-agent/ /agents/examples/chat-agent/ 301
/agents/examples/browse-the-web/ /agents/tools/browser/ 301
/agents/examples/manage-and-sync-state/ /agents/runtime/lifecycle/state/ 301
/agents/examples/manage-and-sync-state/ /agents/agent-class/state/ 301
/agents/examples/rag/ /agents/tools/ai-search/ 301
/agents/tools/rag/ /agents/tools/ai-search/ 301
/agents/examples/run-workflows/ /agents/runtime/execution/run-workflows/ 301
/agents/examples/schedule-tasks/ /agents/runtime/execution/schedule-tasks/ 301
/agents/examples/using-ai-models/ /agents/runtime/operations/using-ai-models/ 301
/agents/examples/websockets/ /agents/runtime/communication/websockets/ 301
/agents/examples/sdk/ /agents/runtime/agents-api/ 301
/agents/examples/run-workflows/ /agents/agent-class/run-workflows/ 301
/agents/examples/schedule-tasks/ /agents/agent-class/schedule-tasks/ 301
/agents/examples/using-ai-models/ /agents/agent-class/using-ai-models/ 301
/agents/examples/websockets/ /agents/agent-class/websockets/ 301
/agents/examples/sdk/ /agents/agent-class/ 301
/agents/examples/build-mcp-server/ /agents/model-context-protocol/guides/remote-mcp-server/ 301
/agents/api-reference/build-mcp-server/ /agents/model-context-protocol/guides/remote-mcp-server/ 301
/agents/api-reference/sdk/ /agents/runtime/agents-api/ 301
/agents/api-reference/sdk/ /agents/agent-class/ 301
/agents/guides/build-mcp-server/ /agents/model-context-protocol/guides/remote-mcp-server/ 301
/agents/capabilities/mcp-server/ /agents/model-context-protocol/ 301
/agents/model-context-protocol/mcp-agent-api/ /agents/model-context-protocol/apis/agent-api/ 301
/agents/model-context-protocol/mcp-client-api/ /agents/model-context-protocol/apis/client-api/ 301
/agents/model-context-protocol/mcp-handler-api/ /agents/model-context-protocol/apis/handler-api/ 301
/agents/api-reference/calling-agents/ /agents/runtime/communication/routing/ 301
/agents/api-reference/calling-agents/ /agents/agent-class/routing/ 301
/agents/community-mcp-server/ /agents/model-context-protocol/cloudflare/servers-for-cloudflare/community-mcp-server/ 301
/agents/patterns/ /agents/concepts/agentic-patterns/ 301
/agents/concepts/patterns/ /agents/concepts/agentic-patterns/ 301
/agents/concepts/anthropic-agent-patterns/ /agents/concepts/agentic-patterns/ 301
/agents/concepts/human-in-the-loop/ /agents/concepts/agentic-patterns/human-in-the-loop/ 301
/agents/concepts/long-running-agents/ /agents/concepts/agentic-patterns/long-running-agents/ 301
/agents/api-reference/agents-api/ /agents/runtime/agents-api/ 301
/agents/api-reference/agents-api/ /agents/agent-class/ 301
/agents/api-reference/ /agents/runtime/ 301
/agents/api-reference/chat-sdk/ /agents/runtime/communication/chat-sdk/ 301
/agents/runtime/execution/chat-sdk/ /agents/runtime/communication/chat-sdk/ 301
/agents/api-reference/agent-tools/ /agents/runtime/execution/agent-tools/ 301
/agents/api-reference/chat-sdk/ /agents/agent-class/communication-channels/chat-sdk/ 301
/agents/runtime/execution/chat-sdk/ /agents/agent-class/communication-channels/chat-sdk/ 301
/agents/api-reference/agent-tools/ /agents/agent-class/agent-tools/ 301
/agents/api-reference/browse-the-web/ /agents/tools/browser/ 301
/agents/api-reference/callable-methods/ /agents/runtime/lifecycle/callable-methods/ 301
/agents/api-reference/chat-agents/ /agents/communication-channels/chat/chat-agents/ 301
/agents/api-reference/client-sdk/ /agents/communication-channels/chat/client-sdk/ 301
/agents/api-reference/callable-methods/ /agents/agent-class/callable-methods/ 301
/agents/api-reference/chat-agents/ /agents/agent-class/communication-channels/chat/chat-agents/ 301
/agents/api-reference/client-sdk/ /agents/agent-class/communication-channels/chat/client-sdk/ 301
/agents/api-reference/codemode/ /agents/tools/codemode/api-reference/ 301
/agents/api-reference/configuration/ /agents/runtime/operations/configuration/ 301
/agents/api-reference/durable-execution/ /agents/runtime/execution/durable-execution/ 301
/agents/api-reference/email/ /agents/communication-channels/email/ 301
/agents/api-reference/durable-execution/ /agents/agent-class/durable-execution/ 301
/agents/api-reference/email/ /agents/agent-class/communication-channels/email/ 301
/agents/api-reference/get-current-agent/ /agents/runtime/lifecycle/get-current-agent/ 301
/agents/api-reference/http-sse/ /agents/runtime/communication/http-sse/ 301
/agents/api-reference/http-sse/ /agents/agent-class/http-sse/ 301
/agents/api-reference/mcp-agent-api/ /agents/model-context-protocol/apis/agent-api/ 301
/agents/api-reference/mcp-client-api/ /agents/model-context-protocol/apis/client-api/ 301
/agents/api-reference/mcp-handler-api/ /agents/model-context-protocol/apis/handler-api/ 301
/agents/api-reference/observability/ /agents/runtime/operations/observability/ 301
/agents/api-reference/protocol-messages/ /agents/runtime/communication/protocol-messages/ 301
/agents/api-reference/queue-tasks/ /agents/runtime/execution/queue-tasks/ 301
/agents/api-reference/protocol-messages/ /agents/agent-class/protocol-messages/ 301
/agents/api-reference/queue-tasks/ /agents/agent-class/queue-tasks/ 301
/agents/api-reference/rag/ /agents/tools/ai-search/ 301
/agents/api-reference/readonly-connections/ /agents/runtime/communication/readonly-connections/ 301
/agents/api-reference/retries/ /agents/runtime/execution/retries/ 301
/agents/api-reference/routing/ /agents/runtime/communication/routing/ 301
/agents/api-reference/run-workflows/ /agents/runtime/execution/run-workflows/ 301
/agents/api-reference/schedule-tasks/ /agents/runtime/execution/schedule-tasks/ 301
/agents/api-reference/readonly-connections/ /agents/agent-class/readonly-connections/ 301
/agents/api-reference/retries/ /agents/agent-class/retries/ 301
/agents/api-reference/routing/ /agents/agent-class/routing/ 301
/agents/api-reference/run-workflows/ /agents/agent-class/run-workflows/ 301
/agents/api-reference/schedule-tasks/ /agents/agent-class/schedule-tasks/ 301
/agents/api-reference/sessions/ /agents/runtime/lifecycle/sessions/ 301
/agents/api-reference/store-and-sync-state/ /agents/runtime/lifecycle/state/ 301
/agents/api-reference/sub-agents/ /agents/runtime/execution/sub-agents/ 301
/agents/api-reference/using-ai-models/ /agents/runtime/operations/using-ai-models/ 301
/agents/api-reference/voice/ /agents/communication-channels/voice/ 301
/agents/api-reference/websockets/ /agents/runtime/communication/websockets/ 301
/agents/api-reference/store-and-sync-state/ /agents/agent-class/state/ 301
/agents/api-reference/sub-agents/ /agents/agent-class/sub-agents/ 301
/agents/api-reference/using-ai-models/ /agents/agent-class/using-ai-models/ 301
/agents/api-reference/voice/ /agents/agent-class/communication-channels/voice/ 301
/agents/api-reference/websockets/ /agents/agent-class/websockets/ 301
/agents/guides/anthropic-agent-patterns/ /agents/concepts/agentic-patterns/ 301
/agents/guides/autonomous-responses/ /agents/communication-channels/chat/autonomous-responses/ 301
/agents/guides/autonomous-responses/ /agents/agent-class/communication-channels/chat/autonomous-responses/ 301
/agents/guides/build-a-voice-agent/ /agents/examples/voice-agent/ 301
/agents/guides/build-mcp-client/ /agents/model-context-protocol/guides/build-mcp-client/ 301
/agents/guides/chatgpt-app/ /workers/demos/chatgpt-app/ 301
Expand All @@ -311,12 +340,12 @@
/agents/guides/cross-domain-authentication/ /agents/runtime/operations/cross-domain-authentication/ 301
/agents/guides/human-in-the-loop/ /agents/concepts/agentic-patterns/human-in-the-loop/ 301
/agents/guides/oauth-mcp-client/ /agents/model-context-protocol/guides/oauth-mcp-client/ 301
/agents/guides/push-notifications/ /agents/communication-channels/webhooks/push-notifications/ 301
/agents/guides/push-notifications/ /agents/agent-class/communication-channels/webhooks/push-notifications/ 301
/agents/guides/remote-mcp-server/ /agents/model-context-protocol/guides/remote-mcp-server/ 301
/agents/guides/securing-mcp-server/ /agents/model-context-protocol/guides/securing-mcp-server/ 301
/agents/guides/slack-agent/ /agents/examples/slack-agent/ 301
/agents/guides/test-remote-mcp-server/ /agents/model-context-protocol/guides/test-remote-mcp-server/ 301
/agents/guides/webhooks/ /agents/communication-channels/webhooks/ 301
/agents/guides/webhooks/ /agents/agent-class/communication-channels/webhooks/ 301
/agents/model-context-protocol/authorization/ /agents/model-context-protocol/protocol/authorization/ 301
/agents/model-context-protocol/protocol/codemode/ /agents/tools/codemode/ 301
/agents/model-context-protocol/codemode/ /agents/model-context-protocol/guides/build-codemode-mcp-server/ 301
Expand All @@ -335,23 +364,23 @@
/agents/agentic-payments/x402/pay-with-tool-plugins/ /agents/tools/payments/x402/pay-with-tool-plugins/ 301
/agents/agentic-payments/mpp/ /agents/tools/payments/mpp/ 301
/agents/guides/ /agents/model-context-protocol/guides/ 301
/agents/concepts/agent-class/ /agents/runtime/lifecycle/agent-class/ 301
/agents/concepts/agent-class/ /agents/agent-class/internals/ 301
/agents/concepts/memory/ /agents/concepts/conversation-state-and-memory/ 301
/agents/getting-started/prompting/ /workers/get-started/prompting/ 301
/agents/platform/prompting/ /workers/get-started/prompting/ 301
/agents/platform/prompt.txt/ /workers/prompt.txt 301
/agents/channels/chat/ /agents/communication-channels/chat/ 301
/agents/channels/chat/chat-agents/ /agents/communication-channels/chat/chat-agents/ 301
/agents/channels/chat/client-sdk/ /agents/communication-channels/chat/client-sdk/ 301
/agents/channels/chat/autonomous-responses/ /agents/communication-channels/chat/autonomous-responses/ 301
/agents/channels/chat/ /agents/agent-class/communication-channels/chat/ 301
/agents/channels/chat/chat-agents/ /agents/agent-class/communication-channels/chat/chat-agents/ 301
/agents/channels/chat/client-sdk/ /agents/agent-class/communication-channels/chat/client-sdk/ 301
/agents/channels/chat/autonomous-responses/ /agents/agent-class/communication-channels/chat/autonomous-responses/ 301
/agents/channels/chat/chatgpt-app/ /workers/demos/chatgpt-app/ 301
/agents/channels/voice/ /agents/communication-channels/voice/ 301
/agents/channels/voice/ /agents/agent-class/communication-channels/voice/ 301
/agents/channels/voice/build-a-voice-agent/ /agents/examples/voice-agent/ 301
/agents/channels/email/ /agents/communication-channels/email/ 301
/agents/channels/slack/ /agents/communication-channels/slack/ 301
/agents/channels/email/ /agents/agent-class/communication-channels/email/ 301
/agents/channels/slack/ /agents/agent-class/communication-channels/slack/ 301
/agents/channels/slack/slack-agent/ /agents/examples/slack-agent/ 301
/agents/channels/webhooks/ /agents/communication-channels/webhooks/ 301
/agents/channels/webhooks/push-notifications/ /agents/communication-channels/webhooks/push-notifications/ 301
/agents/channels/webhooks/ /agents/agent-class/communication-channels/webhooks/ 301
/agents/channels/webhooks/push-notifications/ /agents/agent-class/communication-channels/webhooks/push-notifications/ 301
/agents/communication-channels/voice/build-a-voice-agent/ /agents/examples/voice-agent/ 301
/agents/communication-channels/slack/slack-agent/ /agents/examples/slack-agent/ 301
/agents/tools/browser/browse-the-web/ /agents/tools/browser/ 301
Expand Down
24 changes: 12 additions & 12 deletions src/components/cf/AgentsPlatformDiagram.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,37 @@ const channels = [
{
type: "Chat",
name: "AIChatAgent",
href: "/agents/communication-channels/chat/",
href: "/agents/agent-class/communication-channels/chat/",
},
{
type: "Email",
name: "onEmail",
href: "/agents/communication-channels/email/",
href: "/agents/agent-class/communication-channels/email/",
},
{
type: "Voice",
name: "withVoice",
href: "/agents/communication-channels/voice/",
href: "/agents/agent-class/communication-channels/voice/",
},
{
type: "Slack",
name: "Events",
href: "/agents/communication-channels/slack/",
href: "/agents/agent-class/communication-channels/slack/",
},
{
type: "Webhook",
name: "HTTP",
href: "/agents/communication-channels/webhooks/",
href: "/agents/agent-class/communication-channels/webhooks/",
},
];

const runtime = [
{ label: "State", href: "/agents/runtime/lifecycle/state/" },
{ label: "State", href: "/agents/agent-class/state/" },
{ label: "Sessions", href: "/agents/runtime/lifecycle/sessions/" },
{ label: "Routing", href: "/agents/runtime/communication/routing/" },
{ label: "WebSockets", href: "/agents/runtime/communication/websockets/" },
{ label: "Scheduling", href: "/agents/runtime/execution/schedule-tasks/" },
{ label: "Fibers", href: "/agents/runtime/execution/durable-execution/" },
{ label: "Routing", href: "/agents/agent-class/routing/" },
{ label: "WebSockets", href: "/agents/agent-class/websockets/" },
{ label: "Scheduling", href: "/agents/agent-class/schedule-tasks/" },
{ label: "Fibers", href: "/agents/agent-class/durable-execution/" },
];

const tools = [
Expand Down Expand Up @@ -95,7 +95,7 @@ const tools = [
</div>
<div class="section-row">
<a href="/agents/harnesses/pi/">Pi harness</a>
<a href="/agents/runtime/agents-api/">Build-your-own agent</a>
<a href="/agents/agent-class/">Build-your-own agent</a>
</div>
</div>

Expand All @@ -106,7 +106,7 @@ const tools = [
Durable identity, state, connections, scheduling, and recovery.
</p>
</div>
<a class="agent-class" href="/agents/runtime/agents-api/">
<a class="agent-class" href="/agents/agent-class/">
Agent class
</a>
<div class="runtime-list">
Expand Down
6 changes: 3 additions & 3 deletions src/content/changelog/agents/2025-03-18-npm-i-agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export default {

#### Call Agent methods from your client code <Badge text="New" variant="tip" size="small" />

We've added a new [`@unstable_callable()`](/agents/runtime/agents-api/) decorator for defining methods that can be called directly from clients. This allows you call methods from within your client code: you can call methods (with arguments) and get native JavaScript objects back.
We've added a new [`@unstable_callable()`](/agents/agent-class/) decorator for defining methods that can be called directly from clients. This allows you call methods from within your client code: you can call methods (with arguments) and get native JavaScript objects back.

<TypeScriptExample>

Expand Down Expand Up @@ -127,8 +127,8 @@ You can use the starter as a template for your own Agents projects: open up `src
We've heard your feedback on the Agents SDK documentation, and we're shipping more API reference material and usage examples, including:

- Expanded [API reference documentation](/agents/runtime/), covering the methods and properties exposed by the Agents SDK, as well as more usage examples.
- More [Client API](/agents/runtime/agents-api/#client-api) documentation that documents `useAgent`, `useAgentChat` and the new `@unstable_callable` RPC decorator exposed by the SDK.
- New documentation on how to [route requests to agents](/agents/runtime/communication/routing/) and (optionally) authenticate clients before they connect to your Agents.
- More [Client API](/agents/agent-class/#client-api) documentation that documents `useAgent`, `useAgentChat`, and the new `@unstable_callable` RPC decorator exposed by the SDK.
- New documentation on how to [route requests to agents](/agents/agent-class/routing/) and (optionally) authenticate clients before they connect to your Agents.

Note that the Agents SDK is continually growing: the type definitions included in the SDK will always include the latest APIs exposed by the `agents` package.

Expand Down
2 changes: 1 addition & 1 deletion src/content/changelog/agents/2025-04-07-mcp-servers-agents-sdk-updates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ We've made a number of improvements to the [Agents SDK](/agents/), including:
- Support for building MCP servers with the new `MCPAgent` class.
- The ability to export the current agent, request and WebSocket connection context using `import { context } from "agents"`, allowing you to minimize or avoid direct dependency injection when calling tools.
- Fixed a bug that prevented query parameters from being sent to the Agent server from the `useAgent` React hook.
- Automatically converting the `agent` name in `useAgent` or `useAgentChat` to kebab-case to ensure it matches the naming convention expected by [`routeAgentRequest`](/agents/runtime/communication/routing/).
- Automatically converting the `agent` name in `useAgent` or `useAgentChat` to kebab-case to ensure it matches the naming convention expected by [`routeAgentRequest`](/agents/agent-class/routing/).

To install or update the Agents SDK, run `npm i agents@latest` in an existing project, or explore the `agents-starter` project:

Expand Down
Loading
Loading