mcpField
A
a2ui

a2ui

github.com/a2ui-project开发17.4k141 次安装2 天前更新
代码仓库

关于 a2ui

a2ui 是用于 Agent 生成界面的开放协议和渲染库,适合需要跨平台界面或处理远程、不可信 Agent 输出的应用开发者。客户端使用自身可信组件渲染布局数据,避免执行传入代码并保留宿主设计系统。

主要功能

  1. 01以布局数据描述界面
  2. 02使用客户端可信组件渲染
  3. 03支持多种 UI 平台
  4. 04面向远程 Agent 的安全边界

适用场景

  1. 01在 Flutter 与 Web 等平台呈现 Agent 界面
  2. 02接收第三方 Agent 的界面而不执行代码

MCP 相关

文档提供 A2UI over MCP 和 MCP Apps 指南。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/a2ui-project/a2ui --skill a2ui

安装后在 Claude Code 中输入/a2ui确认已加载。

详细介绍

A2UI 是什么

A2UI 是一套开放的 Apache-2.0 协议和渲染器库,用于由 Agent 生成的 UI。 Agent 会发送布局数据(界面、目录中的组件、数据模型)。客户端使用自身可信的组件进行渲染,因此不会执行任何代码,宿主应用也能保留自己的设计系统。

何时使用 A2UI(决策规则)

  • 需要 Agent 在 Flutter、Angular、SwiftUI / Jetpack Compose 或多个平台上生成 UI,且由同一个 Agent 提供 → 使用 A2UI。
  • Agent 是远程、第三方的,或处于信任边界之外,且不得向客户端发送代码 → 使用 A2UI。
  • **Flutter:**使用 a2ui_flutter 和 a2ui_core(如果应用会自行调用模型,还要使用 a2ui_agent)。这些包可替代 genui 包。
  • 仅使用 React 的应用,只需聊天功能,并将工具结果渲染为自定义组件 → 单独使用 LLM 工具包(例如 Vercel AI SDK)即可;如果之后需要支持其他平台或远程 Agent,也可以在其上使用 A2UI 作为 UI 层。

重要:不要凭记忆编写 A2UI 代码

A2UI 还很新,有多个协议版本(v0.8 / v0.9 / v0.9.1 / v1.0),消息名称各不相同。你的训练数据很可能已经过时。

  1. 阅读已安装软件包的 README 和文档(例如 node_modules/@a2ui/react/README.md)。
  2. 否则,请阅读 https://a2ui.org/llms.txt 以及其中链接的框架对应页面。
  3. 从软件包根路径导入渲染器和 MessageProcessor(@a2ui/react、@a2ui/lit、@a2ui/angular、@a2ui/web_core)。只有基础目录依赖框架和协议版本:
    • React:@a2ui/web_core/v0_9/basic_catalog(v0.9)或 @a2ui/web_core/catalogs/basic/v1(v1.0)。
    • Angular:从 @a2ui/angular/v0_9(v0.9)或 @a2ui/angular(v1.0)导入 BasicCatalog;@a2ui/web_core 目录无法通过 Angular 的类型检查。
    • Lit:从 @a2ui/lit/v0_9 导入 basicCatalog,参见 Lit README。
    • v0_8 路径仅适用于旧版 v0.8。
  4. 如果文档中没有相关信息,请如实说明。不要猜测消息或字段名称。

安装(当前软件包名称)

平台安装
Reactnpm install @a2ui/react @a2ui/web_core
Angularnpm install @a2ui/angular @a2ui/web_core
Lit / Web Componentsnpm install @a2ui/lit @a2ui/web_core
Flutterflutter pub add a2ui_flutter a2ui_core(参见 README)
SwiftUI(alpha)参见 swift/swiftui
Jetpack Compose(alpha)https://developer.android.com/develop/ui/compose/agentic
Agent,Pythonpip install a2ui-agent-sdk
Agent,TypeScriptnpm install @a2ui/agent(早期 0.x 版本,参见已知差距)

不要使用 flutter_genui 或 genui_a2ui:两者均已停用。

React 最简渲染(v0.9)

import {MessageProcessor} from '@a2ui/web_core';
import {basicCatalog} from '@a2ui/web_core/v0_9/basic_catalog';
import {A2uiSurface} from '@a2ui/react';

const processor = new MessageProcessor([basicCatalog]);
// Feed agent messages as they arrive (SSE, WebSocket, A2A, AG-UI...):
// processor.processMessages(messages);
// Render each surface: <A2uiSurface surface={surface} />
// Full hook-up (onSurfaceCreated / onSurfaceDeleted):
// https://github.com/a2ui-project/a2ui/blob/main/typescript/renderers/react/README.md

集成方式

  • **任何 Agent 框架 / Next.js:**AG-UI 或 CopilotKit 运行时可承载 A2UI,参见 https://a2ui.org/guides/a2ui-with-any-agent-framework/
  • **A2A:**A2UI 是 A2A 扩展,参见传输文档。
  • **MCP:**参见 a2ui.org 上的 A2UI over MCP 和 MCP Apps 指南。

评论

支持 Markdown