[Agents] Close documentation gaps vs upstream cloudflare/agents#29219
Closed
whoiskatrin wants to merge 6 commits intoproductionfrom
Closed
[Agents] Close documentation gaps vs upstream cloudflare/agents#29219whoiskatrin wants to merge 6 commits intoproductionfrom
whoiskatrin wants to merge 6 commits intoproductionfrom
Conversation
…man-in-the-loop patterns, websockets, state deprecation, resumable streaming
github-actions
bot
added
product:agents
github-actions
bot
assigned
elithrar,
irvinebroque,
rita3ko,
thomasgauvin and
threepointone
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
Contributor
|
Hey there, we've marked this pull request as stale because there's no recent activity on it. This label helps us identify PRs that might need updates (or to be closed out by our team if no longer relevant). |
3 tasks
Contributor
|
closing this one for #29764, all incorporated there |
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
Closes documentation gaps identified by auditing the upstream
cloudflare/agentssource against the existing Cloudflare developer docs.Changes
New pages
resumable-streaming.mdx— Documents automatic SQLite chunk buffering for mid-stream reconnects, the three-frame resume protocol (CF_AGENT_STREAM_RESUME_REQUEST/CF_AGENT_STREAM_RESUMING/CF_AGENT_STREAM_RESUME_ACK),replay: trueflag on replayed chunks,resume: falseopt-out, and GC timings.guides/client-tools-continuation.mdx— Guide for the auto-continuation flow when client-side tools return results.Updated pages
chat-agents.mdxsanitizeMessageForPersistence, fixedsetMessagesreturn type, added turn coordination helpers (waitUntilStable,resetTurnState,hasPendingInteraction), addedtoolsoption touseAgentChatoptions tablequeue-tasks.mdxqueue()signature to includeoptions?: { retry?: RetryOptions }third param; corrected step 5 description ("Automatic retries"); replaced manual re-queue error handling with built-in retry patternmcp-client-api.mdx0.0.0.0/::) and IPv6 unique-local (fc00::/7) to blocked listhuman-in-the-loop.mdxneedsApprovalserver+client examples; addedonToolCallclient-side execution pattern; added state type patterns (PendingApproval,ApprovalRecord,ApprovalState); added multi-approver pattern; added escalation scheduling exampleagent-class.mdxthis.keepAlive/this.keepAliveWhilesection; added static class options table (hibernate,sendIdentityOnConnect,retry)store-and-sync-state.mdxonStateUpdate→onStateChangeddeprecation/rename noticewebsockets.mdxonError(error)overload; addedshouldSendProtocolMessagesto lifecycle table; addedserverproperty to Connection object table; addedisConnectionProtocolEnabledto connection management table; added Agent properties table (this.name,this.state,this.env,this.ctx)Notes
src/content/docs/agents/were staged withgit add -fdue to.gitignoreline 46 matchingagents/.