# Shared State

> Create a two-way connection between your React Native UI and agent state.

## What is shared 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

<ImageZoom
  src="https://cdn.copilotkit.ai/docs/copilotkit/images/coagents/SharedStateCoAgents.gif"
  alt="Shared State Demo"
  width={1000}
  height={1000}
  className="rounded-lg shadow-lg border mt-0"
/>

## When should I use this? [#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.

<OpsPlatformCTA
  variant="inline"
  title="Building stateful agents?"
  body="Persistent threads ship with CopilotKit Intelligence on the free Developer tier."
  surface="docs_shared_state"
/>

## Reading agent state [#reading-agent-state]

<Callout type="warn" title="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.
</Callout>

<Steps>
  <Step>
    ### Copy UI state into the request context

    The UI writes state with `agent.setState`, and it arrives on the AG-UI run
    input as `inputData.state`. Copy the parts the model needs into a copy of
    the run's `context`. The adapter shows that context to the model during
    the run without saving it as user text:

~~~~typescript title="src/agent/state.ts"
export function withStateContext(inputData: RunAgentInput): RunAgentInput {
  const state =
    inputData.state && typeof inputData.state === "object"
      ? (inputData.state as Record<string, unknown>)
      : {};
  const context = [...inputData.context];
  const preferences = formatPreferencesBlock(state.preferences);
  if (preferences) {
    context.push({
      description: "Current user preferences",
      value: preferences,
    });
  }
  if ("todos" in state) {
    context.push({
      description: "Current sales pipeline",
      value: JSON.stringify(state.todos, null, 2),
    });
  }
  return { ...inputData, context };
}
~~~~

  </Step>
  <Step>
    ### Apply it before every run

    Subclass the agent so every request, including tool continuations, passes
    through `withStateContext`:

~~~~typescript title="src/agent/agent.ts"
export class ShowcaseStrandsAgent extends BoardStateStrandsAgent {
  override async *run(inputData: RunAgentInput) {
    // The adapter exposes context during model calls and restores history afterward.
    yield* super.run(withStateContext(inputData));
  }
}
~~~~

    Do not use `stateContextBuilder` 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.

  </Step>
  <Step>
    ### Send agent writes back to the UI

    The agent writes state through a tool. Give the tool a `stateFromArgs`
    behavior, and the adapter emits a state snapshot the moment the tool
    fires, so the UI re-renders without waiting for the text response:

    ```ts title="src/agent/agent.ts"
    import type { StrandsAgentConfig } from "@ag-ui/aws-strands";
    import { notesStateFromArgs } from "./state";

    const config: StrandsAgentConfig = {
      toolBehaviors: {
        // Shared State (Read + Write) — notes panel.
        set_notes: { stateFromArgs: notesStateFromArgs },
      },
    };
    ```

    ```ts title="src/agent/state.ts"
    export async function notesStateFromArgs(
      ctx: ToolCallContext,
    ): Promise<StatePayload | null> {
      const input = parseToolInput(ctx.toolInput);
      let notes: unknown;
      if (input && typeof input === "object" && !Array.isArray(input)) {
        notes = (input as Record<string, unknown>).notes;
      } else if (Array.isArray(input)) {
        notes = input;
      }
      if (!Array.isArray(notes)) return null;
      return { notes: notes.map((n) => String(n)) };
    }
    ```

    `parseToolInput` parses the call's input when it arrives as a JSON string.
    Pass `config` to `ShowcaseStrandsAgent` with your Strands `Agent`.

  </Step>
</Steps>

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.

```tsx title="src/NotesCard.tsx"
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({ // [!code highlight:4]
    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 [#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.

```tsx
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:

```tsx
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](/react-native/strands-typescript/programmatic-control) for more ways to run the agent from code.

## Rendering shared state in the UI [#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](/react-native/strands-typescript/shared-state/rendering-in-app)** for the full pattern.

## Streaming partial state updates [#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.

<WhenFrameworkSupports feature="shared-state-streaming">

> **Not available for AWS Strands (TypeScript) yet.** The Shared State: Streaming demo for AWS Strands (TypeScript) can't run yet, so its code isn't shown here.

See **[State Streaming](/react-native/strands-typescript/shared-state/streaming)** for the full walkthrough, including the `useAgent` subscription on the frontend.

</WhenFrameworkSupports>

<WhenFrameworkSupports feature="shared-state-streaming" not>

State streaming isn't available on this framework yet. The UI gets the agent's state between checkpoints.

</WhenFrameworkSupports>

## Read-only context [#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](/react-native/strands-typescript/shared-state/agent-readonly)** for the full pattern.

<IntegrationGrid path="shared-state" exclude={["agno", "agent-spec", "spring-ai", "langroid"]} />
