Shared State
Create a two-way connection between your React Native UI and agent state.
What is shared state?
Shared state connects your app's UI with the agent's run. With shared state you can:
- Display the agent's current progress and intermediate results
- Update the agent's state through UI interactions
- React to state changes in real time across your app
When should I use this?
Use shared state when you want the agent and the user to work on the same app state. The UI shows what the agent writes. The agent reads what the user changes in the UI.
Building stateful agents?Persistent threads ship with CopilotKit Intelligence on the free Developer tier.Get CopilotKit Intelligence freeReading agent state
Shared state in Strands is prompt-driven
A Strands agent knows only the state that your code copies into its request context. A state key you don't copy never reaches the model, and nothing reports it: the agent answers as if the UI had written nothing. Say in your system prompt what each copied value means.
Copy UI state into the request context
The UI writes state with agent.setState, and it arrives on the AG-UI run
input as input_data.state. Copy the parts the model needs into the run's
context. The adapter shows that context to the model during the run and
restores the native history afterward, including on tool continuations:
from ag_ui.core.types import Context
def with_state_context(input_data):
"""Copy current UI state into transient AG-UI context, preserving user text.
The adapter supplies context during model calls and restores native history
afterward, including tool continuations. Never use state_context_builder to
prepend application instructions to durable user messages.
"""
context = list(input_data.context)
state = input_data.state
if isinstance(state, dict):
preferences = _format_preferences_block(state.get("preferences") or {})
if preferences:
context.append(
Context(description="Current user preferences", value=preferences)
)
return input_data.model_copy(update={"context": context})_format_preferences_block turns the preferences object into a short
text block for the prompt. Format your own keys the same way.
Apply it before every run
Wrap the StrandsAgent so every request, including tool continuations,
passes through with_state_context:
from collections.abc import AsyncIterator
from contextlib import aclosing
from typing import Any
from ag_ui_strands import StrandsAgent
class _StateContextWrapper:
"""Add transient state context and preserve the adapter's event stream."""
def __init__(self, delegate: StrandsAgent) -> None:
self._delegate = delegate
def __getattr__(self, name: str) -> Any:
return getattr(self._delegate, name)
async def run(self, input_data: Any) -> AsyncIterator[Any]:
# The adapter owns snapshots, including unfinished parallel calls.
async with aclosing(
self._delegate.run(with_state_context(input_data))
) as events:
async for event in events:
yield eventDo not use StrandsAgentConfig(state_context_builder=...) to prepend the
state to the user's message. Its output is saved as native message history,
so every past message keeps the old state. Existing conversations created
that way keep that text; start a new conversation for a clean history.
Send agent writes back to the UI
The agent writes state through a tool. Give the tool a ToolBehavior with
state_from_args, and the adapter emits a state snapshot the moment the
tool fires, so the UI re-renders without waiting for the text response:
from ag_ui_strands import StrandsAgent, StrandsAgentConfig, ToolBehavior
from strands import tool
@tool
def set_notes(notes: list[str]):
"""Replace the notes array in shared state with the full updated list.
Use this whenever the user asks you to remember something, or when
you have an observation about the user worth surfacing in the UI's
notes panel. ALWAYS pass the FULL notes list (existing notes + any
new ones), not a diff. Keep each note short (< 120 chars).
Args:
notes: The complete updated list of short note strings.
Returns:
Confirmation string for the LLM to summarise back to the user.
"""
return f"Notes updated. Tracking {len(notes)} note(s)."
shared_state_config = StrandsAgentConfig(
tool_behaviors={
"set_notes": ToolBehavior(
state_from_args=notes_state_from_args,
),
},
)notes_state_from_args reads the call's tool_input (a JSON string or a
dict) and returns {"notes": [...]}, the snapshot the adapter publishes.
Pass shared_state_config as config= to StrandsAgent, then wrap that
agent in _StateContextWrapper.
Subscribe a component to the agent's state with useAgent. Each time the agent changes its state, for example from a tool call, the hook re-renders your component with the new values.
import { Text, View } from "react-native";
import { useAgent, UseAgentUpdate } from "@copilotkit/react-native/headless";
type NotesState = {
notes?: string[];
preferences?: { tone?: string };
};
export function NotesCard() {
const { agent } = useAgent({
agentId: "default",
updates: [UseAgentUpdate.OnStateChanged],
});
const state = (agent.state ?? {}) as NotesState;
return (
<View style={{ padding: 16, gap: 4 }}>
{(state.notes ?? []).map((note) => (
<Text key={note}>• {note}</Text>
))}
</View>
);
}agent.state is a plain object. Read it like any other React data and render the parts you care about: notes the agent wrote, structured output, progress, or anything else the agent put there.
Writing agent state
The same agent has a setState method. Call it from a UI event, and the agent reads the new value on its next turn. The UI's writes steer the model.
import { Button } from "react-native";
// In NotesCard, below the list:
<Button
title="Prefer short answers"
onPress={() =>
agent.setState({
...state,
preferences: { ...state.preferences, tone: "concise" },
})
}
/>This makes shared state two-way. The UI can send the agent new inputs, such as preferences, selections, or partial work, without the chat.
The agent reads the new state on its next run. To run it right away, call copilotkit.runAgent({ agent }) (from useCopilotKit) after setState. Running through copilotkit also sends your frontend tools and context with the run. To tell the model what changed, add a message first:
const { copilotkit } = useCopilotKit();
agent.setState({ ...state, language: newLanguage });
agent.addMessage({
id: `user-${Date.now()}`,
role: "user",
content: `The language has been updated to ${newLanguage}.`,
});
await copilotkit.runAgent({ agent });See Programmatic Control for more ways to run the agent from code.
Rendering shared state in the UI
Because agent.state is plain React data, the UI layer is whatever you'd normally build. Nothing about it is chat-specific: useAgent works in any component under CopilotKitProvider, so you can render the state on your main screen, not just next to the chat. See Render agent state in your app for the full pattern.
Streaming partial state updates
By default, agent state only updates between backend checkpoints, so a long tool call shows up as one burst at the end. State streaming copies one tool argument into a state key while the model writes it, so the UI shows the answer token by token.
State streaming isn't available on this framework yet. The UI gets the agent's state between checkpoints.
Read-only context
When a value is UI-owned, and the agent should read it but never write it back, use useAgentContext instead of shared state. Examples are the current user, the selected record, or the open screen. It sends values one way, from the UI to the agent, and removes them when the component unmounts.
See Agent Read-Only Context for the full pattern.
How is this guide?