> ## Documentation Index
> Fetch the complete documentation index at: https://springaicommunity.mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Spring AG-UI

> AG-UI protocol implementation for Spring AI

<img src="https://img.shields.io/badge/Status-Incubating-blue" alt="Incubating Status" />

<img src="https://img.shields.io/badge/Recently_Approved-✓-green" alt="Recently Approved" />

## Overview

Spring AI AG-UI provides an implementation of the AG-UI protocol for Spring AI applications. AG-UI is a protocol designed to enable seamless integration between AI agents and user interfaces, allowing for rich, interactive AI-powered applications.

<Note>
  This project was recently approved and is in the process of being migrated to the spring-ai-community organization.
</Note>

## What is AG-UI?

AG-UI (Agent-UI) is a protocol that bridges the gap between AI agents and user interfaces, providing a standardized way for agents to interact with UI components, handle user interactions, and manage application state.

## Key Features

<CardGroup cols={2}>
  <Card title="Protocol Implementation" icon="handshake">
    Full implementation of the AG-UI protocol specification
  </Card>

  <Card title="Spring AI Integration" icon="leaf">
    Native integration with Spring AI's agent capabilities
  </Card>

  <Card title="Java-First" icon="mug-hot">
    Built for Java developers using familiar Spring patterns
  </Card>

  <Card title="Type Safety" icon="shield-check">
    Strongly-typed interfaces for reliable agent-UI communication
  </Card>
</CardGroup>

## Use Cases

<Steps>
  <Step title="Interactive AI Applications">
    Build applications where AI agents can dynamically interact with UI components
  </Step>

  <Step title="Agent Orchestration">
    Coordinate multiple AI agents with shared UI state and interactions
  </Step>

  <Step title="Real-time Updates">
    Enable agents to provide real-time feedback through UI updates
  </Step>

  <Step title="Multi-modal Interfaces">
    Support for text, images, and other media types in agent-UI communication
  </Step>
</Steps>

## Getting Started

### Prerequisites

* Java 17 or later
* Spring Boot 3.x
* Spring AI

### Installation

<Note>
  Maven artifacts will be available once the project is fully migrated to the spring-ai-community organization.
</Note>

## Development Team

* **Pascal Wilbrink** (@pascalwilbrink) - Project maintainer

## Resources

<CardGroup cols={2}>
  <Card title="AG-UI Documentation" icon="book" href="https://docs.ag-ui.com/">
    Official AG-UI protocol documentation
  </Card>

  <Card title="GitHub Repository" icon="github" href="https://github.com/workm8/ag-ui-4j">
    Current repository (will migrate to spring-ai-community)
  </Card>

  <Card title="Project Proposal" icon="file-lines" href="https://github.com/spring-ai-community/community/issues/15">
    Original community proposal
  </Card>
</CardGroup>

## Project Status

<Warning>
  This project is currently in the migration phase. The repository will be transferred to the spring-ai-community organization soon.
</Warning>

## License

This project uses the Apache 2.0 license.