Sync docs for agents PR #610: Readonly state#26742
Closed
agents-git-bot[bot] wants to merge 1 commit intoproductionfrom
Closed
Sync docs for agents PR #610: Readonly state#26742agents-git-bot[bot] wants to merge 1 commit intoproductionfrom
agents-git-bot[bot] wants to merge 1 commit intoproductionfrom
Conversation
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
|
CI run failed: build logs |
d4c7383 to
afdeda4
Compare
Synced from cloudflare/agents PR #610 (cloudflare/agents#610) Introduces documentation for the readonly connections feature which allows restricting certain WebSocket connections from modifying Agent state while still allowing them to receive state updates and call RPC methods. Key features documented: - Server-side methods: shouldConnectionBeReadonly, setConnectionReadonly, isConnectionReadonly - Client-side API: onStateUpdateError callback - Usage examples for query parameter based access, role-based access control, admin dashboards, and dynamic permission changes - Behavior details, best practices, and migration guide - Implementation details including persistence across hibernation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
afdeda4 to
f6a559d
Compare
Contributor
|
Hey there, we've marked this pull request as stale because there's no recent activity on it. This label is helps us identify PRs that might need updates (or to be closed out by our team if no longer relevant). |
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
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
This PR syncs documentation for the readonly connections feature from cloudflare/agents.
Source PR: cloudflare/agents#610
Source PR Title: Readonly state
Changes
Adds comprehensive documentation for readonly connections, a new feature that allows restricting certain WebSocket connections from modifying Agent state while still allowing them to receive state updates and call RPC methods.
Key documentation sections:
shouldConnectionBeReadonly(),setConnectionReadonly(),isConnectionReadonly()onStateUpdateErrorcallback for error handlingUse cases documented:
🤖 Generated with Claude Code