Skip to content

Sync docs for agents PR #610: feat: readonly connections — restrict WebSocket clients from modifying agent state #28197

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
whoiskatrin merged 6 commits into from
Feb 11, 2026
Merged

Sync docs for agents PR #610: feat: readonly connections — restrict WebSocket clients from modifying agent state #28197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d806a23
Sync documentation for PR #610: readonly connections and onStateChanged
github-actions[bot] Feb 8, 2026
56c5783
Fix build: wrap @callable() code snippets in class declarations
opencode-agent[bot] Feb 10, 2026
9eebc7b
Wrap @callable() snippets in class bodies
opencode-agent[bot] Feb 10, 2026
2b9b1a8
Apply suggestions from code review
Oxyjun Feb 10, 2026
be6b411
Delete package-lock.json
whoiskatrin Feb 10, 2026
4476356
fix: resolve merge conflict by restoring package-lock.json from produ…
whoiskatrin Feb 11, 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
4 changes: 2 additions & 2 deletions src/content/docs/agents/api-reference/agents-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ flowchart TD
| `onError(connection, error)` | When a WebSocket error occurs |
| `onClose(connection, code, reason, wasClean)` | When a WebSocket connection closes |
| `onEmail(email)` | When an email is routed to the instance |
| `onStateUpdate(state, source)` | When state changes (from server or client) |
| `onStateChanged(state, source)` | When state changes (from server or client) |

## Core properties

Expand All @@ -77,7 +77,7 @@ flowchart TD

| Feature | Methods | Documentation |
| -------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------- |
| **State** | `setState()`, `onStateUpdate()`, `initialState` | [Store and sync state](/agents/api-reference/store-and-sync-state/) |
| **State** | `setState()`, `onStateChanged()`, `initialState` | [Store and sync state](/agents/api-reference/store-and-sync-state/) |
| **Callable methods** | `@callable()` decorator | [Callable methods](/agents/api-reference/callable-methods/) |
| **Scheduling** | `schedule()`, `scheduleEvery()`, `getSchedules()`, `cancelSchedule()` | [Schedule tasks](/agents/api-reference/schedule-tasks/) |
| **Queue** | `queue()`, `dequeue()`, `dequeueAll()`, `getQueue()` | [Queue tasks](/agents/api-reference/queue-tasks/) |
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/agents/api-reference/client-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ agent.setState({ score: 100, level: 5 });
When you call `setState()`:

1. The state is sent to the agent over WebSocket
2. The agent's `onStateUpdate()` method is called
2. The agent's `onStateChanged()` method is called
3. The agent broadcasts the new state to all connected clients
4. Your `onStateUpdate` callback fires with `source: "client"`

Expand Down
Loading
Loading