1
- [ ![ 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 )
2
- ![ Discord] ( https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff )
1
+
3
2
4
3
5
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
6
5
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.
7
6
8
- ![ AG-UI] ( https://github.com/user-attachments/assets/bec3bc01-d8f2-4667-885e-028cbcbc8439 )
7
+ [ ![ 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 )
8
+ ![ MIT] ( https://img.shields.io/github/license/copilotkit/copilotkit?color=%236963ff&label=License )
9
+ ![ Discord] ( https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff )
10
+
11
+ ![ Banner] ( https://github.com/user-attachments/assets/c92ee75a-d8c5-42f3-aa42-d4511fdc935a )
9
12
13
+ ## 🚀 Getting Started
14
+ Create a new AG-UI application in seconds:
15
+ ``` ts
16
+ npx create - ag - ui - app my - agent - app
17
+ ```
18
+ <h3 >Building AG-UI Integrations (new frameworks):</h3 >
10
19
11
- <img src =" ./assets/banner.png " alt =" ag-ui Logo " style =" width : 100% ; height : auto ;" />
20
+ - [ Build new integrations (Quickstart)] ( )
21
+ - [ Book a call to discuss an AG-UI integration with a new framework] ( )
22
+ - [ Join the Discord Community] ( )
12
23
13
- # What is AG-UI? (Specification)
24
+ ## What is AG-UI?
14
25
15
26
AG-UI is an open, lightweight, event-based protocol for agent-human interaction, designed for simplicity & flexibility:
16
27
@@ -25,7 +36,7 @@ AG-UI is an open, lightweight, event-based protocol for agent-human interaction,
25
36
It also ships with a ** reference HTTP implementation** and ** default connector** to help teams get started fast.
26
37
27
38
28
- [ Learn more about the specs] ( https://go.copilotkit.ai/ag-ui-introduction )
39
+ [ Learn more about the specs → ] ( https://go.copilotkit.ai/ag-ui-introduction )
29
40
30
41
31
42
## Why AG-UI?
@@ -37,12 +48,8 @@ AG-UI is complementary to the other 2 top agentic protocols
37
48
- MCP gives agents tools
38
49
- A2A allows agents to communicate with other agents
39
50
- AG-UI brings agents into user-facing applications
40
-
41
- <div align =" center " >
42
- <img src =" https://github.com/user-attachments/assets/0c1ec566-050b-4ef8-ab89-15be41abe64f " height =" 300px " />
43
- </div >
44
51
45
- ## Features
52
+ ## 🚀 Features
46
53
47
54
- 💬 Real-time agentic chat with streaming
48
55
- 🔄 Bi-directional state synchronization
@@ -51,19 +58,19 @@ AG-UI is complementary to the other 2 top agentic protocols
51
58
- 🛠️ Frontend tool integration
52
59
- 🧑💻 Human-in-the-loop collaboration
53
60
54
- ## Framework Support
61
+ ## 🛠 Supported Frameworks
55
62
56
63
AG-UI integrates with many popular agent frameworks
57
64
58
65
| Framework | Status | AG-UI Resources |
59
66
| ------------------------------------------------------------------ | ------------------------ | ---------------------------------------------------------------------------- |
60
67
| No-framework | ✅ Supported | ➡️ Docs coming soon |
61
- | [ LangGraph] ( https://www.langchain.com/langgraph ) | ✅ Supported | ➡️ [ Demo] ( https://v0-langgraph-land.vercel.app/ ) |
62
- | [ Mastra] ( https://mastra.ai/ ) | ✅ Supported | ➡️ [ Demo] ( https://v0-mastra-land.vercel.app/ ) |
63
- | [ CrewAI] ( https://crewai.com/ ) | ✅ Supported | ➡️ [ Demo] ( https://v0-crew-land.vercel.app/ ) |
64
- | [ AG2] ( https://ag2.ai/ ) | ✅ Supported | ➡️ [ Demo] ( https://v0-ag2-land.vercel.app/ ) |
65
- | [ Agno] ( https://github.com/agno-agi/agno ) | ✅ Supported | ➡️ [ Docs] ( https://docs.copilotkit.ai/agno ) | |
66
- | [ LlamaIndex] ( https://github.com/run-llama/llama_index ) | ✅ Supported | ➡️ [ Docs] ( https://docs.copilotkit.ai/llamaindex ) | |
68
+ | [ LangGraph] ( https://www.langchain.com/langgraph ) | ✅ Supported | ➡️ [ Demo → ] ( https://v0-langgraph-land.vercel.app/ ) |
69
+ | [ Mastra] ( https://mastra.ai/ ) | ✅ Supported | ➡️ [ Demo → ] ( https://v0-mastra-land.vercel.app/ ) |
70
+ | [ CrewAI] ( https://crewai.com/ ) | ✅ Supported | ➡️ [ Demo → ] ( https://v0-crew-land.vercel.app/ ) |
71
+ | [ AG2] ( https://ag2.ai/ ) | ✅ Supported | ➡️ [ Demo → ] ( https://v0-ag2-land.vercel.app/ ) |
72
+ | [ Agno] ( https://github.com/agno-agi/agno ) | ✅ Supported | ➡️ [ Docs → ] ( https://docs.copilotkit.ai/agno ) | |
73
+ | [ LlamaIndex] ( https://github.com/run-llama/llama_index ) | ✅ Supported | ➡️ [ Docs → ] ( https://docs.copilotkit.ai/llamaindex ) | |
67
74
| [ Pydantic AI] ( https://github.com/pydantic/pydantic-ai ) | 🛠️ In Progress | – |
68
75
| [ Vercel AI SDK] ( https://github.com/vercel/ai ) | 🛠️ In Progress | – |
69
76
| [ OpenAI Agent SDK] ( https://openai.github.io/openai-agents-python/ ) | 💡 Open to Contributions | – |
@@ -81,48 +88,33 @@ AG-UI integrates with many popular agent frameworks
81
88
82
89
[ View all supported frameworks →] ( https://ag-ui.com/frameworks )
83
90
84
- ## AG-UI Hello World
91
+ ## ✨ Hello World App
92
+
93
+ https://agui-demo.vercel.app/
85
94
86
95
https://github.com/user-attachments/assets/419e4b8c-09f1-4cf0-b76b-339c7a207584
87
96
88
97
89
- ## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
98
+ ## 🧩 AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
90
99
The [ AG-UI Dojo] ( https://copilotkit-feature-viewer.vercel.app/ ) showcases many of the building blocks that AG-UI supports ([ AG-UI Dojo Source Code] ( https://github.com/ag-ui-protocol/ag-ui/tree/main/typescript-sdk/apps/dojo ) ).
91
100
92
101
The building blocks are designed to be simple and focused -- between 50-200 lines of code.
93
102
94
103
[ Video:] ( https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae )
95
104
96
- ## Getting Started
97
-
98
- Choose your path:
99
-
100
- ### Building AG-UI Powered Applications
101
-
102
- Create a new AG-UI application in seconds:
103
-
104
- ``` bash
105
- npx create-ag-ui-app my-agent-app
106
- ```
107
-
108
- [ View Documentation] ( https://go.copilotkit.ai/ag-ui-introduction ) · [ Join Discord] ( https://discord.gg/Jd3FzfdJa8 )
109
-
110
- ### Building AG-UI Integrations (new frameworks)
111
-
112
- 1 . [ Build new integrations (Quickstart)] ( https://go.copilotkit.ai/build-quickstart )
113
- 2 . [ Book a call to discuss an AG-UI integration with a new framework] ( https://go.copilotkit.ai/ag-ui-book-a-call )
114
- 3 . [ Join the Discord Community] ( https://go.copilotkit.ai/AG-UI-Discord )
115
-
116
-
117
- ## Contributing
118
105
106
+ ## 🙋🏽♂️ Contributing to AG-UI
119
107
120
108
Check out the [ Contributing guide] ( https://github.com/ag-ui-protocol/ag-ui/blob/main/CONTRIBUTING.md )
121
109
122
110
- ** [ AG-UI: Build an agent canvas with AG-UI] ( https://go.copilotkit.ai/ag-ui-build-an-agent-canvas ) **
123
111
📅 Friday, June 20, 9:00 AM PT
124
112
125
113
126
- ## License
114
+ ## 📄 License
115
+
116
+ AG-UI is open source software [ licensed as MIT] ( https://opensource.org/licenses/MIT ) .
117
+ Maintained by [ AG Protocol] ( https://www.agprotocol.ai ) .
118
+
119
+
127
120
128
- AG-UI is open source and available under the MIT License.
0 commit comments