Agent Framework AG-UI Integration

AG-UI protocol integration for Agent Framework, enabling seamless integration with AG-UI's web interface and streaming protocol.

Installation

pip install agent-framework-ag-ui

Quick Start

from fastapi import FastAPI
from agent_framework import ChatAgent
from agent_framework.azure import AzureOpenAIChatClient
from agent_framework_ag_ui import add_agent_framework_fastapi_endpoint

# Create your agent
agent = ChatAgent(
    name="my_agent",
    instructions="You are a helpful assistant.",
    chat_client=AzureOpenAIChatClient(
        endpoint="https://your-resource.openai.azure.com/",
        deployment_name="gpt-4o-mini",
    ),
)

# Create FastAPI app and add AG-UI endpoint
app = FastAPI()
add_agent_framework_fastapi_endpoint(app, agent, "/")

# Run with: uvicorn main:app --reload

Documentation

Getting Started Tutorial - Step-by-step guide to building your first AG-UI server and client
Examples - Complete examples for AG-UI features

Features

This integration supports all 7 AG-UI features:

Agentic Chat: Basic streaming chat with tool calling support
Backend Tool Rendering: Tools executed on backend with results streamed to client
Human in the Loop: Function approval requests for user confirmation before tool execution
Agentic Generative UI: Async tools for long-running operations with progress updates
Tool-based Generative UI: Custom UI components rendered on frontend based on tool calls
Shared State: Bidirectional state sync between client and server
Predictive State Updates: Stream tool arguments as optimistic state updates during execution

Architecture

The package uses a clean, orchestrator-based architecture:

AgentFrameworkAgent: Lightweight wrapper that delegates to orchestrators
Orchestrators: Handle different execution flows (default, human-in-the-loop, etc.)
Confirmation Strategies: Domain-specific confirmation messages (extensible)
AgentFrameworkEventBridge: Converts Agent Framework events to AG-UI events
Message Adapters: Bidirectional conversion between AG-UI and Agent Framework message formats
FastAPI Endpoint: Streaming HTTP endpoint with Server-Sent Events (SSE)

Next Steps

New to AG-UI? Start with the Getting Started Tutorial
Want to see examples? Check out the Examples for AG-UI features

License

MIT

Metadata

Release files for agent-framework-ag-ui 1.0.0b251106

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agent-framework-ag-ui 1.0.0b251106
File	Size	Uploaded
agent_framework_ag_ui-1.0.0b251106.tar.gz	57.1 kB	Nov 6, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for agent-framework-ag-ui 1.0.0b251106
File	Interpreter	ABI	Platform	Reset
agent_framework_ag_ui-1.0.0b251106-py3-none-any.whl 23.4 kB Nov 6, 2025	Python 3	none	any	Details

Total release size: 80.5 kB

Release files / agent_framework_ag_ui-1.0.0b251106.tar.gz

Download URL	agent_framework_ag_ui-1.0.0b251106.tar.gz
Size	57.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`ee361b84b477900815c95ec02567fba3d6ab8b991c8569d876913f63d5ecdc08`
BLAKE2b-256 checksum How to use checksums	`5aa4d7b9f0089edee6324e43bf07ce9f1ce7699e0c73a76437dcc9053aab4871`
Upload date	Nov 6, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.8.24`

Release files / agent_framework_ag_ui-1.0.0b251106-py3-none-any.whl

Download URL	agent_framework_ag_ui-1.0.0b251106-py3-none-any.whl
Size	23.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`52ec109b2a7ebb29ed7f07965acc22024a358d71c71e6ab7b3258e91ac5c31b5`
BLAKE2b-256 checksum How to use checksums	`cc1d31041e47f5a8e97d8bfd40bb1c6bc46cb2640c9b5a4de80ad5771d2de184`
Upload date	Nov 6, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.8.24`