@assistant-ui/react-ag-ui

中文文档
0.1.1发布于 2026/10/28MITTypeScriptES Module构建来源已验证近 30 天下载 35万

AG-UI protocol adapter for assistant-ui

原始使用文档
文档目录4 节
  1. Installation
  2. Usage
  3. Subagents
  4. See also

@assistant-ui/react-ag-ui

AG-UI protocol integration for @assistant-ui/react. Wraps an @ag-ui/client agent in an assistant-ui runtime so any AG-UI-compatible backend (CopilotKit, custom Python/Go/TS agents) can drive the standard assistant-ui components.

Installation

npm install @assistant-ui/react @assistant-ui/react-ag-ui @ag-ui/client@^1.0.3

Usage

"use client";

import { useMemo } from "react";
import { AssistantRuntimeProvider } from "@assistant-ui/react";
import { HttpAgent } from "@ag-ui/client";
import { useAgUiRuntime } from "@assistant-ui/react-ag-ui";

export function Provider({ children }: { children: React.ReactNode }) {
  const agent = useMemo(
    () => new HttpAgent({ url: process.env.NEXT_PUBLIC_AGUI_AGENT_URL! }),
    [],
  );
  const runtime = useAgUiRuntime({ agent });

  return (
    <AssistantRuntimeProvider runtime={runtime}>
      {children}
    </AssistantRuntimeProvider>
  );
}

Subagents

An AG-UI backend that runs subagents (the agents-as-tools pattern) emits SUBAGENT_STARTED / SUBAGENT_FINISHED / SUBAGENT_ERROR plus a subagentRunId on the events each subagent produces. This adapter groups that activity into one nested assistant message per subagent run and attaches it to the spawning tool call as ToolCallMessagePart.messages, joined on SUBAGENT_STARTED.parentToolCallId. PartPrimitive.Messages renders it without extra wiring, and the subagent's name, description, result, and error code ride on that message's agui metadata.

A subagent that names no reachable spawning call (parentToolCallId is optional, may name a call this run never saw, or two runs may name each other) has nowhere to nest, so its output renders in the parent thread instead of being dropped. This matches the downgrade the protocol's own pre-subagent compatibility middleware performs.

A subagent's frontend-executed tool calls work the same way the root agent's do: a call nested on ToolCallMessagePart.messages is reachable by getPendingToolCalls(), resolves through addToolResult, and its result rides the resume as a tool record on the spawning assistant record, the same flattened wire shape these calls had before subagent attribution.

Approval gates cover nested calls too: a gate that names a subagent-scoped call projects onto the nested part, the frontend tool stays unexecuted while the gate is open, decisions recorded through respondToToolApproval land on the nested part, and an undecided gate's result is never exported to the backend.

Two limitations are worth knowing before you rely on this:

  • Nested structure does not survive a reload. Thread restore reads the flattened wire shape, so a restored subagent tool call comes back as a root-level part rather than nested under its spawning call. Results and decisions are preserved; only the nesting is not.

  • Nested human-in-the-loop is not wired up. A SUBAGENT_FINISHED with a suspended outcome marks the nested message requires-action, and its interruptIds are preserved on the message metadata, but there is no resume path that answers them yet.

See also

  • @assistant-ui/react-a2a for the A2A v1.0 protocol.
  • @assistant-ui/react-langgraph for LangGraph SDK agents.

Full API reference, multi-thread setup, and interrupt handling at assistant-ui.com/docs/runtimes/ag-ui. See examples/with-ag-ui for a complete app.

版本与发布记录

@assistant-ui/react-ag-ui 共发布 68 个版本,首次发布于 2025/11/19;过去 12 个月发布了 68 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.1latest2026/10/2810 天前
0.1.02026/10/2315 天前
0.0.712026/10/2018 天前
0.0.702026/10/1623 天前
0.0.692026/10/1325 天前
0.0.682026/10/1226 天前

关于 @assistant-ui/react-ag-ui 的常见问题

@assistant-ui/react-ag-ui 是什么?

AG-UI protocol adapter for assistant-ui

如何安装 @assistant-ui/react-ag-ui?

在项目目录运行 npm install @assistant-ui/react-ag-ui,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18 || ^19)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@assistant-ui/react-ag-ui 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@assistant-ui/react-ag-ui 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@assistant-ui/react-ag-ui 可以商用吗?

@assistant-ui/react-ag-ui 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@assistant-ui/react-ag-ui 的下载量有多少?

根据 npm 官方下载统计,@assistant-ui/react-ag-ui 在 2026/10/07 – 2026/11/05 这 30 天内被下载 349,870 次,日均约 11,662 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@assistant-ui/react-ag-ui 还在维护吗?

最新版本 0.1.1 发布于 2026/10/28(10 天前);至今共发布 68 个版本,其中过去 12 个月发布了 68 个;首次发布于 2025/11/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。