ag-ui README

The project's README from github.com/ag-ui-protocol/ag-ui. As one markdown file: README.md.

ag-ui Logo AG-UI: The Agent-User Interaction Protocol

AG-UI is an open, lightweight, event-based protocol that standardizes how AI agents connect to user-facing applications. Built for simplicity and flexibility, it enables seamless integration between AI agents, real time user context, and user interfaces.



Version MIT Discord

Join our Discord →     Read the Docs →     Go to the AG-UI Dojo →     Follow us →

1600x680

🚀 Getting Started

Create a new AG-UI application in seconds:

npx create-ag-ui-app my-agent-app

Useful Links:

What is AG-UI?

AG-UI is an open, lightweight, event-based protocol for agent-human interaction, designed for simplicity & flexibility:

AG-UI includes a flexible middleware layer that ensures compatibility across diverse environments:

It also ships with a reference HTTP implementation and default connector to help teams get started fast.

Learn more about the specs →

Why AG-UI?

AG-UI was developed based on real-world requirements and practical experience building in-app agent interactions.

Where does AGUI fit in the agentic protocol stack?

AG-UI is complementary to the other 2 top agentic protocols

The Agent Protocol Stack

🚀 Features

🛠 Supported Integrations

AG-UI was born from CopilotKit's initial partnership with LangChain and CrewAI - and brings the incredibly popular agent-user-interactivity infrastructure to the wider agentic ecosystem.

1st party = the platforms that have AG‑UI built in and provide documentation for guidance.

Frameworks

Framework Status AG-UI Resources
Built-in Agent ✅ Supported ➡️ Docs

🤝 Partnerships

Framework Status AG-UI Resources
LangChain ✅ Supported ➡️ Docs 🎮 Demos
CrewAI ✅ Supported ➡️ Docs 🎮 Demos

🧩 1st Party

Framework Status AG-UI Resources
Microsoft Agent Framework ✅ Supported ➡️ Docs 🎮 Demos
Google ADK ✅ Supported ➡️ Docs 🎮 Demos
AWS Strands Agents ✅ Supported ➡️ Docs 🎮 Demos
Mastra ✅ Supported ➡️ Docs 🎮 Demos
Pydantic AI ✅ Supported ➡️ Docs 🎮 Demos
Agno ✅ Supported ➡️ Docs 🎮 Demos
LlamaIndex ✅ Supported ➡️ Docs 🎮 Demos
AG2 ✅ Supported ➡️ Docs 🎮 Demos
AWS Bedrock Agents 🛠️ In Progress –

🌐 Community

Framework Status AG-UI Resources
Claude Agent SDK ✅ Supported 🎮 Demos
Claude Managed Agents SDK ✅ Supported 🎮 Demos
Langroid ✅ Supported 🎮 Demos
OpenAI Agent SDK 🛠️ In Progress –
Cloudflare Agents 🛠️ In Progress –

Agent Interaction Protocols

Protocols Status AG-UI Resources Integrations
A2A ✅ Supported ➡️ Docs Partnership

Infrastructure / Deployment

Platform Status AG-UI Resources Integrations
Amazon Bedrock AgentCore ✅ Supported ➡️ Docs 1st Party

Specification (standard)

Framework Status AG-UI Resources
Oracle Agent Spec ✅ Supported ➡️ Docs 🎮 Demos

Generative UI

Framework Status AG-UI Resources
MCP Apps ✅ Supported ➡️ Docs 🎮 Demos

SDKs

SDK Status AG-UI Resources Integrations
Kotlin ✅ Supported ➡️ Getting Started Community
Golang ✅ Supported ➡️ Getting Started Community
Dart ✅ Supported ➡️ Getting Started Community
Java ✅ Supported ➡️ Getting Started Community
Rust ✅ Supported ➡️ Getting Started Community
Ruby ✅ Supported ➡️ Getting Started Community
C++ ✅ Supported ➡️ GitHub Source Community
.NET ✅ Supported ➡️ Getting Started Community
Nim 🛠️ In Progress ➡️ PR Community
Flowise 🛠️ In Progress ➡️ GitHub Source Community
Langflow 🛠️ In Progress ➡️ GitHub Source Community

Clients

Client Status AG-UI Resources Integrations
CopilotKit ✅ Supported ➡️ Getting Started 1st Party
Terminal + Agent ✅ Supported ➡️ Getting Started Community
Chat platforms (Slack, Microsoft Teams) ✅ Supported ➡️ Channels SDK 🎮 OpenTag example 1st Party
React Native ✅ Supported ➡️ Example 1st Party

View all supported integrations →

Examples

Hello World App

Video:

https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae

https://agui-demo.vercel.app/

The AG-UI Dojo (Building-Blocks Viewer)

The AG-UI Dojo demonstrates AG-UI's core building blocks through simple, focused examples—each just 50-200 lines of code.

View the source code for the Dojo and all framework integrations here.

https://github.com/user-attachments/assets/c298eea8-3f39-4a94-b968-7712429b0c49

🙋🏽‍♂️ Contributing to AG-UI

Check out the Contributing guide

Roadmap

Check out the AG-UI Roadmap to see what's being built and where you can jump in.

📄 License

AG-UI is open source software licensed as MIT.

ag-ui (ag-ui-protocol/ag-ui)

agent-ui
Searching Database…

16.7K ·GitHub
What is this?AG-UI is an open, lightweight, event-based protocol that standardizes how AI agents connect to user-facing applications — a shared event contract between an agent backend and the UI that shows its work.
Is it a specification I read, or code I install?It's a protocol spec: agent backends emit events matching about 16 standard event types, and a middleware layer lets them flow over any transport — SSE, WebSockets, webhooks — with SDKs and a reference HTTP implementation shipped in this repo.
Which agent frameworks can I plug in?First-party and partner support covers LangChain, CrewAI, Microsoft Agent Framework, Google ADK, AWS Strands Agents, Mastra, Pydantic AI, Agno, LlamaIndex and AG2; community integrations include the Claude Agent SDK and Langroid.
Which integrations are still in progress?AWS Bedrock Agents, the OpenAI Agent SDK and Cloudflare Agents on the framework side, plus the Nim SDK and the Flowise and Langflow integrations, are not finished yet.
Where can the agent's UI actually run?Anywhere you can build a client: CopilotKit web apps, a terminal-plus-agent setup, chat platforms like Slack and Microsoft Teams, and React Native mobile apps are all documented clients.
What can an app built on AG-UI actually do?Real-time agentic chat with streaming, bi-directional state synchronization, generative UI with structured messages, real-time context enrichment, frontend tool integration and human-in-the-loop collaboration.
How does AG-UI fit next to MCP and A2A?They are complementary layers of the agentic stack: MCP gives agents tools, A2A lets agents communicate with other agents, and AG-UI brings agents into user-facing applications.
Do the SDKs exist for languages other than TypeScript?Yes — community SDKs cover Kotlin, Golang, Dart, Java, Rust, Ruby, C++ and .NET, with Nim in progress, so your agent backend can stay in its own stack.
What is the AG-UI Dojo?The project's building-blocks viewer: simple, focused examples of core AG-UI features, each just 50-200 lines of code, with all source in the repo — a quick way to see each capability in isolation.
What are similar projects?CopilotKit, tambo, openui, LibreChat, boardui, ai, taskuary, deer-flow
Size
76.5 MB
Stars
16.7K
Age
1y
Commits · 90 Days