mcpField
A
ag-ui-protocol

ag-ui-protocol

github.com/meetsmore开发1185 次安装今天更新
代码仓库

关于 ag-ui-protocol

AG-UI Protocol 是用于 AI Agent 与面向用户的应用通信的开放事件协议。本技能提供协议文档与参考，适合实现事件流、状态同步、工具调用和消息传输的开发者。

主要功能

  1. 01事件类型与模式说明
  2. 02消息结构与角色说明
  3. 03工具定义和调用生命周期
  4. 04状态快照与增量同步
  5. 05服务端和客户端快速入门

适用场景

  1. 01为 Agent 与前端实现事件通信
  2. 02构建消息和工具调用流
  3. 03调试状态同步与事件流程

安装

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

$npx skills add https://github.com/meetsmore/use-ai --skill ag-ui-protocol

安装后在 Claude Code 中输入/ag-ui-protocol确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

docs/2025-11-27/
introduction.md
docs/2025-11-27/concepts/
agents.md
architecture.md
events.md
messages.md
middleware.md
serialization.md
state.md
tools.md
docs/2025-11-27/quickstart/
clients.md
introduction.md
server.md

详细介绍

AG-UI 协议

Agent-User Interaction（AG-UI）协议是一种开放、轻量、基于事件的协议，用于规范 AI Agent 与面向用户的应用程序之间的连接方式。

何时使用此技能

在以下情况下使用此技能：

  • 在代码中实现 AG-UI 协议事件
  • 构建通过 AG-UI 与前端通信的 Agent
  • 了解事件类型及其结构
  • 实现状态管理、工具调用或消息流式传输
  • 调试 AG-UI 事件流

文档

完整的 AG-UI 协议文档见 docs/2025-11-27/ 目录：

  • introduction.md - 协议概览和集成
  • concepts/architecture.md - 核心架构和设计
  • concepts/events.md - 事件类型和模式
  • concepts/messages.md - 消息结构和类型
  • concepts/state.md - 状态管理和同步
  • concepts/tools.md - 工具定义和生命周期
  • concepts/agents.md - Agent 实现
  • concepts/middleware.md - 中间件模式
  • concepts/serialization.md - 事件序列化和压缩
  • quickstart/introduction.md - 入门指南
  • quickstart/server.md - 服务端实现
  • quickstart/clients.md - 客户端实现

快速参考

事件类型
enum EventType {
  // Lifecycle
  RUN_STARTED = "RUN_STARTED",
  RUN_FINISHED = "RUN_FINISHED",
  RUN_ERROR = "RUN_ERROR",
  STEP_STARTED = "STEP_STARTED",
  STEP_FINISHED = "STEP_FINISHED",

  // Text Messages
  TEXT_MESSAGE_START = "TEXT_MESSAGE_START",
  TEXT_MESSAGE_CONTENT = "TEXT_MESSAGE_CONTENT",
  TEXT_MESSAGE_END = "TEXT_MESSAGE_END",

  // Tool Calls
  TOOL_CALL_START = "TOOL_CALL_START",
  TOOL_CALL_ARGS = "TOOL_CALL_ARGS",
  TOOL_CALL_END = "TOOL_CALL_END",

  // State
  STATE_SNAPSHOT = "STATE_SNAPSHOT",
  STATE_DELTA = "STATE_DELTA",
  MESSAGES_SNAPSHOT = "MESSAGES_SNAPSHOT",

  // Custom
  RAW = "RAW",
  CUSTOM = "CUSTOM",
}
事件模式
  1. 开始-内容-结束：增量流式传输内容（文本、工具参数）
  2. 快照-增量：使用完整快照和 JSON Patch 更新进行状态同步
  3. 生命周期：通过必需的开始/结束事件监控运行状态
消息角色
  • user - 用户消息（文本和多模态）
  • assistant - AI 响应（文本和工具调用）
  • system - 指令或上下文
  • tool - 工具执行结果
  • activity - 进度更新
  • developer - 内部调试
工具定义结构
interface Tool {
  name: string;           // Unique identifier
  description: string;    // Purpose explanation
  parameters: JSONSchema; // Accepted arguments
}
工具调用生命周期
  1. TOOL_CALL_START - 使用唯一 ID 启动
  2. TOOL_CALL_ARGS - 流式传输 JSON 参数
  3. TOOL_CALL_END - 标记完成
状态同步
  • STATE_SNAPSHOT - 完整替换状态
  • STATE_DELTA - 增量 JSON Patch（RFC 6902）更新

来源

文档下载自：https://github.com/ag-ui-protocol/ag-ui/tree/main/docs

评论

支持 Markdown