Shared State

Create a two-way connection between your UI and agent 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
Shared State Demo

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.

Building stateful agents?Persistent threads ship with CopilotKit Intelligence on the free Developer tier.Get CopilotKit Intelligence free

Reading 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 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:

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 };
}

Apply it before every run

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

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.

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:

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 },
  },
};
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.

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.

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

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.

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

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 for the full main-view pattern.

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

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.

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 the framework grid for the frameworks where it runs.

See State streaming for the full walkthrough, including the corresponding 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, 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 for the full pattern.

How is this guide?