# Agent Read-Only Context

> Send UI values to the agent as a one-way, read-only channel with useAgentContext.

## What is this? [#what-is-this]

Sometimes you want the agent to *know* something about the current UI, like the signed-in user, the open screen, or a recent activity log, but you don't want the agent to change it. That's what `useAgentContext` is for: a one-way **UI → agent** channel for read-only context.

Unlike full shared state, where the agent can write state back to the UI, `useAgentContext` values are pure inputs. The agent sees them on every turn, but it has no setter and no tool to write them back.

## When should I use this? [#when-should-i-use-this]

Use `useAgentContext` instead of full shared state when:

- The value is **UI-owned** and means nothing to the agent beyond "what the user is looking at right now".
- The agent should read but never write (user identity, feature flags, selected record, open screen).
- You want the value to go away when the component unmounts. For example, the "current record" context disappears when the user leaves that screen.

Think of it as "props for the agent".

If the agent must also write the value, use **[shared state](/react-native/langgraph-python/shared-state)**. To stream agent-written state to the UI during a run, see [State Streaming](/react-native/langgraph-python/shared-state/streaming).

## How it works in code [#how-it-works-in-code]

<Steps>
  <Step>
    ### Install the LangGraph Python SDK

    <Tabs className="p-0 m-0" groupId="python-pm" items={['uv', 'poetry', 'pip', 'conda']} default="uv">
    <Tab value="uv">
    ```bash
    uv add copilotkit
    ```
    </Tab>
    <Tab value="poetry">
    ```bash
    poetry add copilotkit
    ```
    </Tab>

    <Tab value="pip">

    ```bash
    pip install copilotkit --extra-index-url https://copilotkit.gateway.scarf.sh/simple/
    ```
    </Tab>

    <Tab value="conda">
    ```bash
    conda install copilotkit -c copilotkit-channel
    ```
    </Tab>

</Tabs>

  </Step>
  <Step>
    ### Wire read-only agent context into your graph

    `useAgentContext` publishes read-only UI values through
    `CopilotKitMiddleware`. Attach the middleware to the agent and describe
    how the model should use the frontend-supplied context in the system
    prompt.

~~~~python title="readonly_state_agent_context.py"
graph = create_agent(
    model=ChatOpenAI(reasoning_effort="none", model="gpt-6-luna"),
    tools=[],
    middleware=[CopilotKitMiddleware()],
    system_prompt=(
        "You are a helpful, concise assistant. The frontend may provide "
        "read-only context about the user (e.g. name, timezone, recent "
        "activity) via the `useAgentContext` hook. Always consult that "
        "context when it is relevant — address the user by name if known, "
        "respect their timezone when mentioning times, and reference "
        "recent activity when it helps you answer. Keep responses short."
    ),
)
~~~~

  </Step>
  <Step>
    ### Using a custom graph instead of `create_agent`

    `CopilotKitMiddleware` only works with `create_agent`. In a graph where you
    define the nodes and edges yourself, nothing adds the context to the
    prompt for you. Inherit your state from `CopilotKitState`, read the
    entries from `state["copilotkit"]["context"]` in a node, and pass them to
    the model yourself.

    Each entry's `value` arrives as a JSON string. Parse it with `json.loads`
    before you read a field. Without the parse, `colleagues[0]` is a single
    character, not a colleague.

    ```python title="agent.py"
    import json

    from langchain_core.runnables import RunnableConfig
    from langchain_core.messages import SystemMessage
    from langchain_openai import ChatOpenAI
    from copilotkit import CopilotKitState # extends MessagesState

    class AgentState(CopilotKitState):
        # ... Your defined state properties
        pass

    def chat_node(state: AgentState, config: RunnableConfig):
        # Extract the colleagues from CopilotKit context
        colleagues_context_item = next(
            (item for item in state["copilotkit"]["context"] if item.get("description") == "The current user's colleagues"),
            None
        )

        # The value is a JSON string, so parse it to read the fields
        colleagues = []
        if colleagues_context_item:
            colleagues = json.loads(colleagues_context_item["value"])

        # Now each entry is a dict, so colleague["name"] works
        colleague_list = ", ".join(f"{c['name']} ({c['role']})" for c in colleagues)

        # Provide the list of colleagues to the LLM
        system_message = SystemMessage(
            content=f"""You are a helpful assistant that can help emailing colleagues.
            The user's colleagues are: {colleague_list}"""
        )

        response = ChatOpenAI(model="gpt-6-luna", reasoning_effort="none").invoke(
            [system_message, *state["messages"]],
            config
        )

        return {
            **state,
            "messages": response,
        }
    ```

  </Step>
</Steps>

Call `useAgentContext({ description, value })` once per value you want to send. Each call registers a context entry that is:

- Refreshed whenever `value` changes.
- Removed when the component unmounts.
- Sent to the agent with every run. The Built-in Agent adds each entry to the system prompt. Python LangGraph agents need `CopilotKitMiddleware` to add the entries, and ADK agents need an instruction provider. Microsoft Agent Framework, CrewAI Flows, and Pydantic AI agents drop the entries silently unless you wire them. The setup above shows the code for your framework.

```tsx title="src/ProfileScreen.tsx"
import { Text, View } from "react-native";
import { useAgentContext } from "@copilotkit/react-native/headless";

export function ProfileScreen({
  userName,
  timezone,
  recentActivity,
}: {
  userName: string;
  timezone: string;
  recentActivity: string[];
}) {
  useAgentContext({ // [!code highlight:4]
    description: "The signed-in user's name and timezone",
    value: { userName, timezone },
  });

  useAgentContext({
    description: "The last actions the user took in the app, newest first",
    value: recentActivity,
  });

  return (
    <View style={{ padding: 16 }}>
      <Text>Signed in as {userName}</Text>
    </View>
  );
}
```

The `description` matters. It's a short label the agent sees next to the value, so it knows what to do with it. Treat it like a parameter docstring.

Call `useAgentContext` in as many components as you like. The agent receives every entry that is registered at the time of the run.

<Callout type="warn" title="Context values arrive as JSON strings">
  The AG-UI protocol defines a context value as a string. Therefore
  `useAgentContext` calls `JSON.stringify` on any `value` that is not already a
  string, and your agent receives the JSON text instead of the object or the
  array.

  Parse the value before you read a field from it. Use `json.loads(item["value"])`
  in Python, or `JSON.parse(item.value)` in TypeScript. If you skip the parse
  step, an index such as `colleagues[0]` returns a single character, and a shape
  check such as `isinstance(value, list)` can never pass.

  Do not stringify the value again, because that produces double encoding. A
  `value` that is already a string is sent unchanged, so no parse step is needed
  for it.
</Callout>

## Wire it to your own state [#wire-it-to-your-own-state]

`useAgentContext` doesn't care where the value comes from: local state, a React context, Redux, a query cache, or your navigation state. The value must be JSON-serializable. Its serialized form is compared on each render, so a new object with the same contents does not register the entry again.

## Rendering data does not send it [#rendering-data-does-not-send-it]

A screen that renders a list has put the list in the view tree, not in the agent's context. Those are separate steps. An agent without the second step still answers: the text reads well, the values look plausible, and nothing errors.

Register the data with `useAgentContext`, and tell the agent in its instructions to refuse to answer about records that the context doesn't carry. Then check one answer against the records your app actually holds.

## Treat entries as untrusted input [#treat-entries-as-untrusted-input]

Every entry is a claim your app made, and a user can change it. It never proves who is making the request. Let entries inform the agent's answer, but take facts that grant access, such as the authenticated user, the workspace, or the tenant, from your server. If your agent builds its prompt from entries, keep them apart from your own instructions, so text in an entry can't override them.

## Try it [#try-it]

Ask the agent: "What is my name?" It answers with the value of `userName`. Change the name in your app and ask again: the answer changes.

For every option, see the [`useAgentContext` reference](/reference/react-native/hooks/useAgentContext).
