Skip to content

Commit 16e5f9b

Browse files
Update README.md V2 (#94)
* Update README.md V2 Do not merge * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
1 parent 6b11d68 commit 16e5f9b

File tree

1 file changed

+61
-60
lines changed

1 file changed

+61
-60
lines changed

README.md

Lines changed: 61 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1+
12
[![AG-UI Workshop – June 20](https://img.shields.io/badge/AG--UI%20Workshop%20%E2%80%94June%2020-blue?style=flat-square)](https://go.copilotkit.ai/ag-ui-build-an-agent-canvas)
3+
24
![Discord](https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff)
35

4-
# <img src="https://github.com/user-attachments/assets/ebc0dd08-8732-4519-9b6c-452ce54d8058" alt="ag-ui Logo" height="42px" /> AG-UI: The Agent-User Interaction Protocol
56

6-
AG-UI is an open, lightweight, event-based protocol that standardizes **how AI agents connect to front-end applications**.
7+
# <img src="https://github.com/user-attachments/assets/ebc0dd08-8732-4519-9b6c-452ce54d8058" alt="ag-ui Logo" height="42px" /> AG-UI: The Agent-User Interaction Protocol
8+
AG-UI is a lightweight, event-based protocol that standardizes how AI agents connect to front-end applications. Built for simplicity and flexibility, it enables seamless integration between your AI agents and user interfaces.
79

8-
➡️ See demos of AG-UI-enabled applications [here](https://github.com/ag-ui-protocol/ag-ui?tab=readme-ov-file#ag-ui-compatible-agent-frameworks)
10+
![AG-UI](https://github.com/user-attachments/assets/bec3bc01-d8f2-4667-885e-028cbcbc8439)
911

10-
<img src="https://github.com/user-attachments/assets/215227a5-9698-4d97-a46e-8904b95bfa08" alt="ag-ui Logo" style="max-width: 100px; height: auto;" />
1112

12-
# ➡️ Learn more (AG-UI Specification)
13+
# What is AG-UI? (Specification)
1314

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

16-
- During agent executions, agent backends **emit events _compatible_ with one of AG-UI's 16 standard event types**
17+
- During agent executions, agent backends **emit events _compatible_ with one of AG-UI's ~16 standard event types**
1718
- Agent backends can **accept one of a few simple AG-UI compatible inputs** as arguments
1819

1920
**AG-UI includes a flexible middleware layer** that ensures compatibility across diverse environments:
@@ -23,7 +24,9 @@ AG-UI is an open, lightweight, event-based protocol for agent-human interaction,
2324

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

26-
[Learn more at docs.ag-ui.com](https://ag-ui.com)
27+
28+
[Learn more about the specs](https://go.copilotkit.ai/ag-ui-introduction)
29+
2730

2831
## Where does AGUI fit in the agentic protocol stack?
2932
AG-UI is complementary to the other 2 top agentic protocols
@@ -38,99 +41,97 @@ AG-UI is complementary to the other 2 top agentic protocols
3841

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

41-
It was shaped through:
42-
43-
- Working with users in the CopilotKit community to understand the needs of agent-based interactions in applications
44-
- Collaborating closely with leading agent frameworks (LangGraph, Mastra, CrewAI, AG2, etc.)
45-
- Extracting common infrastructure patterns that emerged across varied frameworks into a standardized, open protocol
46-
47-
This practical approach has helped ensure that AG-UI is both flexible and immediately applicable in real-world use cases.
48-
49-
# ➡️ Build AG-UI-Powered Applications
50-
51-
Play with this hello-world app here:
52-
https://agui-demo.vercel.app/
53-
54-
Video:
55-
56-
https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae
44+
## Where does AGUI fit in the agentic protocol stack?
45+
AG-UI is complementary to the other 2 top agentic protocols
46+
- MCP gives agents tools
47+
- A2A allows agents to communicate with other agents
48+
- AG-UI brings agents into user-facing applications
5749

58-
## Select Your Language
50+
<div align="center">
51+
<img src="https://github.com/user-attachments/assets/0c1ec566-050b-4ef8-ab89-15be41abe64f" height="300px" />
52+
</div>
53+
54+
## Features
5955

60-
- [TypeScript](https://github.com/ag-ui-protocol/ag-ui/tree/main/typescript-sdk)
61-
- [Python](https://github.com/ag-ui-protocol/ag-ui/tree/main/python-sdk)
56+
- 💬 Real-time agentic chat with streaming
57+
- 🔄 Bi-directional state synchronization
58+
- 🧩 Generative UI and structured messages
59+
- 🧠 Real-time context enrichment
60+
- 🛠️ Frontend tool integration
61+
- 🧑‍💻 Human-in-the-loop collaboration
6262

63-
## AG-UI Compatible Agent Frameworks
63+
## Framework Support
6464

65-
AG-UI works with several popular agent frameworks and frontend solutions:
65+
AG-UI integrates with many popular agent frameworks
6666

6767
| Framework | Status | AG-UI Resources |
6868
| ------------------------------------------------------------------ | ------------------------ | ---------------------------------------------------------------------------- |
69-
| [LangGraph](https://www.langchain.com/langgraph) | ✅ Supported | ➡️ [Live Demo / Getting Started Docs](https://v0-langgraph-land.vercel.app/) |
70-
| [Mastra](https://mastra.ai/) | ✅ Supported | ➡️ [Live Demo / Getting Started Docs](https://v0-mastra-land.vercel.app/) |
71-
| [CrewAI](https://crewai.com/) | ✅ Supported | ➡️ [Live Demo / Getting Started Docs](https://v0-crew-land.vercel.app/) |
72-
| [AG2](https://ag2.ai/) | ✅ Supported | ➡️ [Live Demo / Getting Started Docs](https://v0-ag2-land.vercel.app/) |
69+
| No-framework | ✅ Supported | ➡️ Docs coming soon |
70+
| [LangGraph](https://www.langchain.com/langgraph) | ✅ Supported | ➡️ [Demo](https://v0-langgraph-land.vercel.app/) |
71+
| [Mastra](https://mastra.ai/) | ✅ Supported | ➡️ [Demo](https://v0-mastra-land.vercel.app/) |
72+
| [CrewAI](https://crewai.com/) | ✅ Supported | ➡️ [Demo](https://v0-crew-land.vercel.app/) |
73+
| [AG2](https://ag2.ai/) | ✅ Supported | ➡️ [Demo](https://v0-ag2-land.vercel.app/) |
7374
| [Agno](https://github.com/agno-agi/agno) | 🛠️ In Progress ||
74-
| [LlamaIndex](https://www.llamaindex.ai) | 🛠️ In Progress ||
75+
| [LlamaIndex](https://github.com/run-llama/llama_index) | 🛠️ In Progress ||
76+
| [Pydantic AI](https://github.com/pydantic/pydantic-ai) | 🛠️ In Progress ||
77+
| [Vercel AI SDK](https://github.com/vercel/ai) | 🛠️ In Progress ||
7578
| [OpenAI Agent SDK](https://openai.github.io/openai-agents-python/) | 💡 Open to Contributions ||
7679
| [Google ADK](https://google.github.io/adk-docs/get-started/) | 💡 Open to Contributions ||
77-
| [Vercel AI SDK](https://github.com/vercel/ai) | 💡 Open to Contributions ||
7880
| [AWS Bedrock Agents](https://aws.amazon.com/bedrock/agents/) | 💡 Open to Contributions ||
7981
| [Cloudflare Agents](https://developers.cloudflare.com/agents/) | 💡 Open to Contributions ||
80-
| [Pydantic AI ](https://ai.pydantic.dev/) | 💡 Open to Contributions ||
8182
| [Strands Agents SDK](https://github.com/strands-agents/sdk-python) | 💡 Open to Contributions ||
8283

8384
| Language SDK | Status | AG-UI Resources |
8485
| ------------------------------------------------------------------ | ------------------------ | ---------------------------------------------------------------------------- |
8586
| [.NET]() | 🛠️ In Progress | ➡️ [PR](https://github.com/ag-ui-protocol/ag-ui/pull/38) |
8687
| [Nim]() | 🛠️ In Progress | ➡️ [PR](https://github.com/ag-ui-protocol/ag-ui/pull/29) |
88+
| [Rust]() | 🛠️ In Progress | |
8789

88-
## Features
8990

90-
AG-UI-compatible agents **securely** and **efficiently** support:
91+
[View all supported frameworks →](https://ag-ui.com/frameworks)
9192

92-
- 💬 Agentic chat with real-time streaming
93-
- 🔄 Bi-directional state sync (in and out of chat)
94-
- 🧩 Generative UI and structured messages (with delta streaming)
95-
- 🧠 Realtime context enrichment
96-
- 🛠️ Frontend tool use (tool calls)
97-
- 🧑‍💻 Human-in-the-loop and human-on-the-loop collaboration
93+
## AG-UI Hello World
9894

99-
And more. [Learn more at ag-ui.com](https://ag-ui.com)
95+
Play with this hello-world app here: https://agui-demo.vercel.app/
10096

101-
## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
97+
[Video:](https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae)
10298

103-
The [ag-ui dojo](https://feature-viewer-langgraph.vercel.app/) showcases many of the building blocks that ag-ui supports.
99+
100+
## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
101+
The AG-UI Dojo showcases many of the building blocks that AG-UI supports.
104102

105103
The building blocks are designed to be simple and focused -- between 50-200 lines of code.
106104

107-
https://github.com/user-attachments/assets/a67d3d54-36b2-4c7a-ac69-a0ca01365d5b
105+
## Getting Started
108106

109-
## Client Libraries
107+
Choose your path:
110108

111-
AG-UI provides ready-to-use client libraries for building connected experiences:
109+
### Building AG-UI Powered Applications
112110

113-
- **React client** via [CopilotKit](https://docs.copilotkit.ai/)
114-
- Messaging clients (WhatsApp, WeChat, RCS) — WIP in collaboration with AWS SNS
111+
Create a new AG-UI application in seconds:
115112

116-
# ➡️ Contribute to AG-UI
113+
```bash
114+
npx create-ag-ui-app my-agent-app
115+
```
117116

118-
Learn how to contribute to AG-UI: [AG-UI Contribution Guide](https://go.copilotkit.ai/agui-contribute)
117+
[View Documentation](https://go.copilotkit.ai/ag-ui-introduction) · [Join Discord](https://discord.gg/Jd3FzfdJa8)
119118

120-
Book time with Markus Ecker, the creator of AG-UI: https://calendly.com/markus-copilotkit/ag-ui
119+
### Building AG-UI Integrations (new frameworks)
121120

122-
Join the Discord: https://discord.gg/Jd3FzfdJa8
121+
1. [Build new integrations (Quickstart)](https://go.copilotkit.ai/build-quickstart)
122+
2. [Book a call to discuss an AG-UI integration with a new framework](https://go.copilotkit.ai/ag-ui-book-a-call)
123+
3. [Join the Discord Community](https://go.copilotkit.ai/AG-UI-Discord)
123124

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

126-
## Community
126+
## Contributing
127+
127128

128-
### Upcoming Events
129+
Check out the [Contributing guide](https://github.com/ag-ui-protocol/ag-ui/blob/main/CONTRIBUTING.md)
129130

130131
- **[AG-UI: Build an agent canvas with AG-UI](https://go.copilotkit.ai/ag-ui-build-an-agent-canvas)**
131132
📅 Friday, June 20, 9:00 AM PT
132133

133134

134-
## Contributing
135+
## License
135136

136-
We 💜 contributions! Whether you're fixing bugs, improving documentation, or building demos — your contributions make AG-UI better.
137+
AG-UI is open source and available under the MIT License.

0 commit comments

Comments
 (0)