Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ag-ui-protocol/ag-ui

AG-UI: the Agent-User Interaction Protocol. Bring Agents into Frontend Applications.
https://github.com/ag-ui-protocol/ag-ui

ag-ui-protocol agent-frontend agent-ui agentic-workflow ai-agents

Last synced: 8 days ago
JSON representation

AG-UI: the Agent-User Interaction Protocol. Bring Agents into Frontend Applications.

Awesome Lists containing this project

README 

          

# 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](https://img.shields.io/npm/v/@ag-ui/core?label=Version&color=6963ff&logo=npm&logoColor=white)](https://www.npmjs.com/package/@ag-ui/core)

![MIT](https://img.shields.io/github/license/copilotkit/copilotkit?color=%236963ff&label=License)

![Discord](https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff)



 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:

```bash

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

```



 Useful Links:



- [The AG-UI Dojo](https://dojo.ag-ui.com/)

- [Build AG-UI-powered applications(Quickstart)](https://docs.ag-ui.com/quickstart/applications)

- [Build new AG-UI framework integrations (Quickstart)](https://go.copilotkit.ai/agui-contribute)

- [Book a call to discuss an AG-UI integration with a new framework](https://calendly.com/markus-copilotkit/ag-ui)

- [Join the Discord Community](https://discord.gg/Jd3FzfdJa8)



## What is AG-UI?



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



- During agent executions, agent backends **emit events _compatible_ with one of AG-UI's ~16 standard event types**

- Agent backends can **accept one of a few simple AG-UI compatible inputs** as arguments



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



- Works with **any event transport** (SSE, WebSockets, webhooks, etc.)

- Allows for **loose event format matching**, enabling broad agent and app interoperability



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



[Learn more about the specs →](https://go.copilotkit.ai/ag-ui-introduction)



## 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

- MCP gives agents tools

- A2A allows agents to communicate with other agents

- AG-UI brings agents into user-facing applications





  The Agent Protocol Stack




## 🚀 Features



- 💬 Real-time agentic chat with streaming

- 🔄 Bi-directional state synchronization

- 🧩 Generative UI and structured messages

- 🧠 Real-time context enrichment

- 🛠️ Frontend tool integration

- 🧑‍💻 Human-in-the-loop collaboration



## 🛠 Supported Integrations



AG-UI was born from CopilotKit's initial **partnership** with LangGraph 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](https://docs.copilotkit.ai/direct-to-llm)  |



### 🤝 Partnerships

| Framework | Status | AG-UI Resources |

| ---------- | ------- | ---------------- |

| [LangGraph](https://www.langchain.com/langgraph) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/langgraph/) 🎮 [Demos](https://dojo.ag-ui.com/langgraph-fastapi/feature/shared_state) |

| [CrewAI](https://crewai.com/) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/crewai-flows) 🎮 [Demos](https://dojo.ag-ui.com/crewai/feature/shared_state) |



### 🧩 1st Party

| Framework | Status | AG-UI Resources |

| ---------- | ------- | ---------------- |

| [Microsoft Agent Framework](https://azure.microsoft.com/en-us/blog/introducing-microsoft-agent-framework/) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/microsoft-agent-framework) 🎮 [Demos](https://dojo.ag-ui.com/microsoft-agent-framework-dotnet/feature/shared_state) |

| [Google ADK](https://google.github.io/adk-docs/get-started/) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/adk) 🎮 [Demos](https://dojo.ag-ui.com/adk-middleware/feature/shared_state?openCopilot=true) |

| [AWS Strands Agents](https://github.com/strands-agents/sdk-python) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/aws-strands) 🎮 [Demos](https://dojo.ag-ui.com/aws-strands/feature/shared_state) |

| [Mastra](https://mastra.ai/) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/mastra/) 🎮 [Demos](https://dojo.ag-ui.com/mastra/feature/tool_based_generative_ui) |

| [Pydantic AI](https://github.com/pydantic/pydantic-ai) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/pydantic-ai/) 🎮 [Demos](https://dojo.ag-ui.com/pydantic-ai/feature/shared_state) |

| [Agno](https://github.com/agno-agi/agno) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/agno/) 🎮 [Demos](https://dojo.ag-ui.com/agno/feature/tool_based_generative_ui) |

| [LlamaIndex](https://github.com/run-llama/llama_index) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/llamaindex/) 🎮 [Demos](https://dojo.ag-ui.com/llamaindex/feature/shared_state) |

| [AG2](https://ag2.ai/) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/ag2/)  🎮 [Demos](https://dojo.ag-ui.com/ag2/feature/shared_state) |

| [AWS Bedrock Agents](https://aws.amazon.com/bedrock/agents/) | 🛠️ In Progress | – |



### 🌐 Community

| Framework | Status | AG-UI Resources |

| ---------- | ------- | ---------------- |

| [OpenAI Agent SDK](https://openai.github.io/openai-agents-python/) | 🛠️ In Progress | – |

| [Cloudflare Agents](https://developers.cloudflare.com/agents/) | 🛠️ In Progress | – |



## Agent Interaction Protocols



| Protocols | Status | AG-UI Resources | Integrations |

| ---------- | ------- | ---------------- | ------------- |

| [A2A]() | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/a2a-protocol) | Partnership |



## Specification (standard)

| Framework | Status | AG-UI Resources |

| ---------- | ------- | ---------------- |

| [Oracle Agent Spec](http://oracle.github.io/agent-spec/) | ✅ Supported | ➡️ [Docs](https://go.copilotkit.ai/copilotkit-oracle-docs) 🎮 [Demos](https://dojo.ag-ui.com/agent-spec-langgraph/feature/tool_based_generative_ui) |



## Generative UI

| Framework | Status | AG-UI Resources |

| ---------- | ------- | ---------------- |

| [MCP Apps](https://blog.modelcontextprotocol.io/posts/2025-11-21-mcp-apps/) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/generative-ui-specs/mcp-apps) 🎮 [Demos]() |



## SDKs



| SDK | Status | AG-UI Resources | Integrations |

| --- | ------- | ---------------- | ------------- |

| [Kotlin]() | ✅ Supported | ➡️ [Getting Started](https://github.com/ag-ui-protocol/ag-ui/blob/main/docs/sdk/kotlin/overview.mdx) | Community |

| [Golang]() | ✅ Supported | ➡️ [Getting Started](https://github.com/ag-ui-protocol/ag-ui/blob/main/docs/sdk/go/overview.mdx) | Community |

| [Dart]() | ✅ Supported | ➡️ [Getting Started](https://github.com/ag-ui-protocol/ag-ui/tree/main/sdks/community/dart) | Community |

| [Java]() | ✅ Supported | ➡️ [Getting Started](https://github.com/ag-ui-protocol/ag-ui/blob/main/docs/sdk/java/overview.mdx) | Community |

| [Rust]() | ✅ Supported | ➡️ [Getting Started](https://github.com/ag-ui-protocol/ag-ui/tree/main/sdks/community/rust/crates/ag-ui-client) | Community |

| [Ruby]() | ✅ Supported | ➡️ [Getting Started](https://github.com/ag-ui-protocol/ag-ui/tree/main/sdks/community/ruby) | Community |

| [.NET]() | 🛠️ In Progress | ➡️ [PR](https://github.com/ag-ui-protocol/ag-ui/pull/38) | Community |

| [Nim]() | 🛠️ In Progress | ➡️ [PR](https://github.com/ag-ui-protocol/ag-ui/pull/29) | Community |

| [Flowise]() | 🛠️ In Progress | ➡️ [GitHub Source](https://github.com/ag-ui-protocol/ag-ui/issues/367) | Community |

| [Langflow]() | 🛠️ In Progress | ➡️ [GitHub Source](https://github.com/ag-ui-protocol/ag-ui/issues/366) | Community |



## Clients



| Client | Status | AG-UI Resources | Integrations |

| --- | ------- | ---------------- | ------------- |

| [CopilotKit](https://github.com/CopilotKit/CopilotKit) | ✅ Supported | ➡️ [Getting Started](https://docs.copilotkit.ai/direct-to-llm/guides/quickstart) | 1st Party |

| [Terminal + Agent]() | ✅ Supported | ➡️ [Getting Started](https://docs.ag-ui.com/quickstart/clients) | Community |

| [React Native]() | 🛠️ Help Wanted | ➡️ [GitHub Source](https://github.com/ag-ui-protocol/ag-ui/issues/510) | Community |



[View all supported integrations →](https://docs.ag-ui.com/introduction#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/ag-ui-protocol/ag-ui/tree/main/apps/dojo).



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



## 🙋🏽‍♂️ Contributing to AG-UI



Check out the [Contributing guide](https://github.com/ag-ui-protocol/ag-ui/blob/main/CONTRIBUTING.md)



- **[Bi-Weekely AG-UI Working Group](https://lu.ma/CopilotKit?k=c)**

  📅 Follow the CopilotKit Luma Events Calendar



## Roadmap



Check out the [AG-UI Roadmap](https://github.com/orgs/ag-ui-protocol/projects/1) to see what's being built and where you can jump in.



## 📄 License



AG-UI is open source software [licensed as MIT](https://opensource.org/licenses/MIT).