[Agents] Close documentation gaps vs upstream SDK#29764
Merged
threepointone merged 1 commit intoproductionfrom Apr 11, 2026
Merged
[Agents] Close documentation gaps vs upstream SDK#29764threepointone merged 1 commit intoproductionfrom
threepointone merged 1 commit intoproductionfrom
Conversation
- chat-agents: add messageConcurrency, onChatResponse, sanitizeMessageForPersistence, saveMessages/persistMessages docs, turn lifecycle helpers (waitUntilStable, hasPendingInteraction, resetTurnState) - schedule-tasks: add schedule() idempotent option, scheduleEvery() idempotency, cron idempotency note - queue-tasks: fix queue() signature to include retry options, replace manual re-queue example with built-in retry - mcp-client-api: fix SSRF blocklist (loopback allowed for local dev), add MCPServerFilter to getAITools(), document callbackHost auto-derivation - client-sdk: add readable state property on useAgent/AgentClient - websockets: add onError server-level overload, shouldSendProtocolMessages, Connection.uri/tags/server, isConnectionProtocolEnabled, Agent properties table - agent-class: add static options table, keepAlive/keepAliveWhile section - human-in-the-loop: expand from 2 patterns to 5 with decision table/tree, add needsApproval, onToolCall, MCP elicitation code examples - configuration: add TypeScript (agents/tsconfig) and Vite (agents/vite) sections - callable-methods: update troubleshooting with agents/vite plugin + agents/tsconfig - quick-start: add tsconfig.json and vite.config.ts to project structure - add-to-existing-project: add step 4 for TypeScript and Vite configuration Co-authored-by: whoiskatrin <whoiskatrin@users.noreply.github.com> Made-with: Cursor
threepointone
requested review from
a team,
elithrar,
irvinebroque,
rita3ko,
thomasgauvin and
whoiskatrin
as code owners
github-actions
bot
added
product:agents
github-actions
bot
assigned
elithrar,
irvinebroque,
rita3ko,
thomasgauvin and
whoiskatrin
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
This was referenced Apr 11, 2026
Contributor
whoiskatrin
approved these changes
Apr 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation update to close gaps between the upstream
cloudflare/agentsSDK and the public-facing docs. Audited all commits from the last ~2 months and updated 12 pages.Thanks to @whoiskatrin for the groundwork in #29219 — several of the fixes here (queue retry signature, SSRF blocklist correction, HITL expansion, websocket additions) were identified in that PR and are incorporated into this one.
New pages
guides/push-notifications.mdx— Full guide: VAPID keys, agent with subscription management, service worker, client subscribe flow, production considerationsUpdated pages
chat-agents.mdxmessageConcurrency,onChatResponse,sanitizeMessageForPersistence,saveMessages/persistMessages(properly documented), turn lifecycle helpers (waitUntilStable,hasPendingInteraction,resetTurnState)schedule-tasks.mdxschedule()idempotentoption,scheduleEvery()idempotency section, cron idempotency note, push-notifications cross-linkqueue-tasks.mdxqueue()signature to includeoptions.retry, addedretrytoQueueItemtype, replaced manual re-queue example with built-in retrymcp-client-api.mdxMCPServerFiltertogetAITools(), documentedcallbackHostauto-derivationclient-sdk.mdxstateproperty onuseAgent/AgentClientwebsockets.mdxonError(error)server-level overload,shouldSendProtocolMessagesto lifecycle table,Connection.uri/tags/serverproperties,isConnectionReadonly/isConnectionProtocolEnabledto management table, "Suppressing protocol messages" section, "Agent properties" tableagent-class.mdxstatic optionstable (hibernate,sendIdentityOnConnect,hungScheduleTimeoutSeconds,keepAliveIntervalMs,retry),keepAlive()/keepAliveWhile()sectionhuman-in-the-loop.mdxneedsApprovalserver+client examples,onToolCallclient-side pattern, MCP elicitation example, timeouts/escalation with codeconfiguration.mdxagents/tsconfig) and "Vite configuration" (agents/vite) sectionscallable-methods.mdxagents/viteplugin +agents/tsconfiginstead of manualtargetsettingquick-start.mdxtsconfig.jsonandvite.config.tsto project file list with setup instructionsadd-to-existing-project.mdxagents/tsconfigandagents/vitepluginTest plan
agentsand@cloudflare/ai-chatsourceMade with Cursor