Reading agent state - Copilotkit

import { ImageZoom } from 'fumadocs-ui/components/image-zoom'; import RunAndConnect from "@/snippets/integrations/mastra/run-and-connect.mdx" import { IframeSwitcher } from "@/components/content"

<Callout type="info"> This example demonstrates reading from shared state in the [CopilotKit Feature Viewer](https://feature-viewer.copilotkit.ai/mastra/feature/shared_state). </Callout>

What is this?

You can easily use the realtime agent state not only in the chat UI, but also in the native application UX.

<Callout type="info" title="Important"> This guide assumes you are embedding your Mastra agent inside of Copilot Runtime, like so.

const runtime = new CopilotRuntime({
  agents: MastraAgent.getLocalAgents({ mastra, resourceId: "user-1" }),
});

This feature will not work if you are using a remote Mastra agent. </Callout>

When should I use this?

You can use this when you want to provide the user with feedback about what your working memory. As your agent's state updates, you can reflect these updates natively in your application.

Implementation

<Steps> <Step> ### Run and connect your agent <RunAndConnect components={props.components} /> </Step> <Step> ### Define the Agent State Mastra has advanced [working memory concepts](https://mastra.ai/en/docs/memory/working-memory) to provide statefulness to your agents. CopilotKit leverages Mastra's working memory concept to allow you to implement shared state between your agent and your application.

Providing working memory to your agent is as simple as providing a Zod schema to your agent.

```ts title="mastra/agents/language-agent.ts"
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { LibSQLStore } from "@mastra/libsql";
import { z } from "zod";
import { Memory } from "@mastra/memory";

// [!code highlight:4]
// 1. Define the agent state schema
export const AgentStateSchema = z.object({
  language: z.enum(["english", "spanish"]),
});

// 2. Infer the agent state type from the schema
export const AgentState = z.infer<typeof AgentStateSchema>;

// 3. Create the agent
export const languageAgent = new Agent({
  name: "Language Agent",
  model: openai("gpt-5.4"),
  instructions: "Always communicate in the preferred language of the user as defined in your working memory. Do not communicate in any other language.",
  memory: new Memory({
    storage: new LibSQLStore({ id: "mastra-storage", url: ":memory:" }),
    options: {
      // [!code highlight:4]
      workingMemory: {
        enabled: true,
        schema: AgentStateSchema,
      },
    },
  }),
});
```

</Step> <Step> ### Use the `useAgent` Hook With your agent connected and running all that is left is to call the `useAgent` hook, pass the agent's name, and initialize missing UI-owned state after the connected agent is ready.

```tsx title="ui/app/page.tsx"
import { useEffect } from "react";
import { useAgent } from "@copilotkit/react-core/v2"; // [!code highlight]
import { AgentState } from "@/mastra/agents/language-agent";

function YourMainContent() {
  // [!code highlight:5]
  const { agent, isReady } = useAgent({
    agentId: "your-mastra-agent-name",
  });
  const state = (agent.state ?? {}) as Partial<AgentState>;

  useEffect(() => {
    if (!isReady || state.language !== undefined) return;
    agent.setState({ ...(agent.state ?? {}), language: "english" });
  }, [agent, isReady, state.language]);

  // ...

  return (
    // style excluded for brevity
    <div>
      <h1>Your main content</h1>
      <p>Language: {agent.state?.language}</p>
    </div>
  );
}
```
<Callout type="info">
  The `agent.state` in `useAgent` is reactive and will automatically update when the working memory changes.
</Callout>

</Step> <Step> ### Give it a try! As the agent state updates, your `state` variable will automatically update with it! In this case, you'll see the language set to "english" after the connected agent is ready. </Step> </Steps>

Rendering agent state in your app

You can render the agent state in any React component under <CopilotKit>. Read agent.state and return ordinary JSX.

tsx

import { useAgent } from "@copilotkit/react-core/v2";

type AgentState = {
  language: "english" | "spanish";
};

function YourMainContent() {
  const { agent } = useAgent({
    agentId: "your-mastra-agent-name",
  });
  const state = (agent.state ?? {}) as Partial<AgentState>;

  if (!state.language) return null;
  return <div>Language: {state.language}</div>;
}

<Callout type="info"> The `agent.state` in `useAgent` is reactive and will automatically update when the working memory changes. </Callout>