Documentation Index#

Fetch the complete documentation index at: https://docs.ag-ui.com/llms.txt Use this file to discover all available pages before exploring further.

Client package overview

@ag-ui/client#

The Agent User Interaction Protocol Client SDK provides agent connectivity options for AI systems. This package builds on the core types and events to deliver flexible connection methods to agent implementations.

npm install @ag-ui/client

AbstractAgent#

AbstractAgent is the base agent class for implementing custom agent connectivity. Extending this class and implementing run() lets you bridge your own service or agent implementation to AG-UI.

• Configuration - Setup with agent ID, messages, and state
• Core Methods - Run, abort, and clone functionality
• Protected Methods - Extensible hooks for custom implementations
• Properties - State and message tracking

Base class for creating custom agent connections

HttpAgent#

Concrete implementation for HTTP-based agent connectivity:

• Configuration - URL and header setup
• Methods - HTTP-specific execution and cancellation
• Protected Methods - Customizable HTTP request handling
• Properties - Connection management

Ready-to-use HTTP implementation for agent connectivity, using a highly efficient event encoding format

Middleware#

Transform and intercept event streams flowing through agents with a flexible middleware system:

• Function Middleware - Simple transformations with plain functions
• Class Middleware - Stateful middleware with configuration
• Built-in Middleware - FilterToolCallsMiddleware and more
• Middleware Patterns - Common use cases and examples

Powerful event stream transformation and filtering for AG-UI agents

AgentSubscriber#

Event-driven subscriber system for handling agent lifecycle events and state mutations during agent execution:

• Event Handlers - Lifecycle, message, tool call, and state events
• State Management - Mutation control and propagation handling
• Usage Examples - Logging, persistence, and error handling patterns
• Integration - Registering and using subscribers with agents

Comprehensive event system for reactive agent interaction and middleware-style functionality