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
Declare the state with state_schema
Pass a state_schema to AgentFrameworkAgent. The adapter adds the
current shared state to the model's context on every turn, so values the
UI writes with agent.setState(...) reach the model. Without a
state_schema, the agent never sees those writes.
STATE_SCHEMA: dict[str, object] = {
"preferences": {
"type": "object",
"description": (
"User-supplied preferences. Adapt every response to match. "
"Address the user by name when appropriate."
),
"properties": {
"name": {"type": "string"},
"tone": {"type": "string"},
"language": {"type": "string"},
"interests": {"type": "array", "items": {"type": "string"}},
},
},
"notes": {
"type": "array",
"items": {"type": "string"},
"description": (
"Short notes the agent has chosen to remember about the "
"user. Updated by calling `set_notes` with the FULL list."
),
},
}Write state from a tool with predict_state_config
The agent writes state through a tool call. predict_state_config maps a
tool argument to a state key, and the adapter sends the new value to the
UI. The tool itself only returns a string for the model:
from typing import Annotated
from agent_framework import Agent, BaseChatClient, tool
from agent_framework_ag_ui import AgentFrameworkAgent
from pydantic import Field
PREDICT_STATE_CONFIG: dict[str, dict[str, str]] = {
"notes": {
"tool": "set_notes",
"tool_argument": "notes",
},
}
@tool(
name="set_notes",
description=(
"Replace the notes array in shared state with the full updated "
"list. Always pass the FULL list of short note strings "
"(existing notes + any new ones), not a diff. Keep each note "
"short (< 120 chars)."
),
)
def set_notes(
notes: Annotated[
list[str],
Field(
description=(
"The complete updated list of short note strings. "
"Must include every existing note you want to keep "
"plus any new ones."
)
),
],
) -> str:
"""Push the agent-authored notes into AG-UI shared state."""
return f"Notes updated. Tracking {len(notes)} note(s)."
def create_shared_state_read_write_agent(
chat_client: BaseChatClient,
) -> AgentFrameworkAgent:
base_agent = Agent(
client=chat_client,
name="shared_state_read_write_agent",
instructions=SYSTEM_PROMPT, # tells the model to call set_notes
tools=[set_notes],
)
return AgentFrameworkAgent(
agent=base_agent,
name="CopilotKitMSAgentSharedStateReadWriteAgent",
description=(
"Bidirectional shared-state demo. Reads UI-written "
"`preferences` from shared state every turn and writes "
"agent-authored `notes` back via the `set_notes` tool."
),
state_schema=STATE_SCHEMA,
predict_state_config=PREDICT_STATE_CONFIG,
require_confirmation=False,
)The mapped value replaces the state key, so have the tool take the
whole value (the full notes list), not a diff. Tell the model the same
thing in its instructions.
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.
# Tells the runtime to stream tool-argument deltas straight into
# `state.document` while `write_document` is still streaming — matches
# LGP's StateStreamingMiddleware setup.
PREDICT_STATE_CONFIG: dict[str, dict[str, str]] = {
"document": {
"tool": "write_document",
"tool_argument": "document",
}
}See State Streaming for the full walkthrough, including the useAgent subscription on the frontend.
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?