mcpField
A
ag-ui-protocol

ag-ui-protocol

github.com/meetsmore開発1185 回インストール今日更新
リポジトリ

ag-ui-protocol について

AG-UI Protocolは、AIエージェントとユーザー向けアプリケーションの通信を定めるオープンなイベントベースのプロトコルです。このスキルは、イベントフロー、状態同期、ツール呼び出し、メッセージストリーミングを実装する開発者向けの資料を提供します。

主な機能

  1. 01イベントの種類とパターン
  2. 02メッセージ構造とロール
  3. 03ツール定義と呼び出しのライフサイクル
  4. 04状態スナップショットと差分同期
  5. 05サーバーとクライアントのクイックスタート

活用シーン

  1. 01エージェントとフロントエンド間のイベント通信を実装
  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 Protocol

Agent-User Interaction（AG-UI）Protocol は、AI エージェントとユーザー向けアプリケーションの接続方法を標準化する、オープンで軽量なイベントベースのプロトコルです。

このスキルを使用するタイミング

次の場合にこのスキルを使用してください。

  • コードに AG-UI プロトコルのイベントを実装する
  • AG-UI 経由でフロントエンドと通信するエージェントを構築する
  • イベントの種類と構造を理解する
  • 状態管理、ツール呼び出し、またはメッセージのストリーミングを実装する
  • 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 - エージェントの実装
  • 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 対応