Overview
bundle add ag-ui-protocolAgUiProtocol::Core
The Agent User Interaction Protocol SDK uses a streaming event-based architecture with strongly typed data structures. This package provides the foundation for connecting to agent systems.
require "ag_ui_protocol"Types
Core data structures that represent the building blocks of the system:
- RunAgentInput - Input parameters for running agents
- Message types - User assistant communication and tool usage
- Context - Contextual information provided to agents
- Tool - Defines functions that agents can call
- State - Agent state management
Types Reference
Complete documentation of all types in the AgUiProtocol::Core::Types namespace
Events
Events that power communication between agents and frontends:
- Lifecycle Events - Run and step tracking
- Text Message Events - Assistant message streaming
- Tool Call Events - Function call lifecycle
- State Management Events - Agent state updates
- Special Events - Raw and custom events
Events Reference
Complete documentation of all events in the AgUiProtocol::Core::Events namespace
