# Shared State

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

## What is shared state? [#what-is-shared-state]

Shared state connects your 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 application

<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 collaborate through the same application state. The agent's outputs are reflected in the UI, and user updates in the UI are reflected in the agent's execution.

<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]

<Steps>
  <Step>
    ### 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.

    ```python title="src/agents/shared_state_read_write_agent.py"
    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."
            ),
        },
    }
    ```

  </Step>
  <Step>
    ### 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:

    ```python title="src/agents/shared_state_read_write_agent.py"
    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.

  </Step>
</Steps>

Subscribe a component to the agent's state with `useAgent`. Any time the agent mutates its state, for example via a tool call, the composable updates its reactive `agent` ref and your UI re-renders with the new values.

```vue title="src/components/SharedWorkspace.vue"
<script setup lang="ts">
import { computed } from "vue";
import { useAgent, UseAgentUpdate } from "@copilotkit/vue/v2";

type WorkspaceState = {
  notes?: string[];
  preferences?: { tone?: string };
};

const { agent } = useAgent({
  agentId: "workspace",
  updates: [UseAgentUpdate.OnStateChanged],
});
const state = computed(
  () => (agent.value?.state ?? {}) as WorkspaceState,
);
</script>

<template>
  <ul>
    <li v-for="note in state.notes ?? []" :key="note">{{ note }}</li>
  </ul>
</template>
```

The returned `agent.value.state` is a plain object. Read it like any other reactive application data and render the parts you care about: agent-written notes, structured outputs, progress indicators, or anything else the agent has put there.

## Writing agent state [#writing-agent-state]

The same agent object exposes `setState`. Calling it from a UI event handler pushes the new value into shared state, and the agent reads it back on its next turn. The UI's writes visibly steer the model.

```vue title="src/components/SharedWorkspace.vue"
<script setup lang="ts">
function setTone(tone: string) {
  const current = agent.value;
  if (!current) return;

  const previous = (current.state ?? {}) as WorkspaceState;
  current.setState({
    ...previous,
    preferences: { ...previous.preferences, tone },
  });
}
</script>

<template>
  <button @click="setTone('concise')">Prefer concise answers</button>
</template>
```

The UI can also send the agent new inputs, such as preferences, selections, or partial work, without the chat.

## Rendering shared state in the UI [#rendering-shared-state-in-the-ui]

Because `agent.state` is plain data exposed through a Vue ref, the UI layer is ordinary Vue. The example above wires the agent's outputs into a list and feeds user edits back through `setState`.

Nothing about this is chat-specific: `useAgent` works in any component under `CopilotKitProvider`, so you can render shared state in your main view or canvas, not just inside the chat panel. See **[Render agent state in your app](/vue/shared-state/rendering-in-app)** for the full main-view pattern.

```vue title="src/App.vue"
<script setup lang="ts">
import { CopilotChat, CopilotKitProvider } from "@copilotkit/vue/v2";
import SharedWorkspace from "./components/SharedWorkspace.vue";
</script>

<template>
  <CopilotKitProvider runtime-url="/api/copilotkit">
    <SharedWorkspace />
    <CopilotChat agent-id="workspace" />
  </CopilotKitProvider>
</template>
```

## Streaming partial state updates [#streaming-partial-state-updates]

By default, shared state only updates *between* backend checkpoints, so a long-running tool call appears as one big burst at the end. State streaming copies a tool argument into a state key while the model writes it, so the UI can watch the answer assemble token-by-token. The sample below is the LangGraph (Python) version.

```python title="src/agents/shared_state_streaming.py"
# 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](/vue/shared-state/streaming)** for the full walkthrough, including the corresponding `useAgent` subscription on the frontend.

## Read-only context [#read-only-context]

When a value is **UI-owned** and the agent should read it but never write it back, such as current user, selected record, or scroll position, reach for `useAgentContext` instead of full shared state. It publishes values as a one-way UI-to-agent channel that auto-unregisters on unmount.

`useAgentContext` is a separate read-only capability; it does not replace the bidirectional `agent.state` / `agent.setState(...)` contract above.

See **[Agent read-only context](/vue/shared-state/agent-readonly)** for the full pattern.

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