docs(agents): add protocol messages documentation#28386
Closed
threepointone wants to merge 1 commit into
Closed
Conversation
Add new page documenting `shouldSendProtocolMessages` and `isConnectionProtocolEnabled` for per-connection control of protocol text frames. Update cross-references in agents-api, websockets, readonly-connections, store-and-sync-state, and mcp-client-api pages. Corresponds to cloudflare/agents#920. Co-authored-by: Cursor <cursoragent@cursor.com>
threepointone
requested review from
elithrar,
irvinebroque,
rita3ko,
thomasgauvin and
whoiskatrin
as code owners
February 17, 2026 07:39
github-actions
Bot
added
product:agents
github-actions
Bot
assigned
elithrar,
irvinebroque,
rita3ko,
thomasgauvin and
whoiskatrin
Contributor
Author
|
Commit cherry-picked directly onto agents-050 — included in #28378 instead. |
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
Documents the new
shouldSendProtocolMessages/isConnectionProtocolEnabledfeature from cloudflare/agents#920, which adds per-connection control over protocol text frames.Changes
api-reference/protocol-messages.mdx— full documentation including overview, usage, API reference, examples (query param, WebSocket subprotocol, combining with readonly), how-it-works explanationagents-api.mdx— added "Protocol messages" row to the server-side API reference tablewebsockets.mdx— added note in the "Handling binary data" section linking to protocol messages for binary-only clientsreadonly-connections.mdx— added cross-reference in "Related resources" and note in "How it works" about shared WebSocket attachment mechanismstore-and-sync-state.mdx— clarified thatsetState()broadcasts exclude protocol-suppressed connectionsmcp-client-api.mdx— added note that MCP server list broadcasts respect the protocol messages filterMade with Cursor