You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thanks for checking out AG-UI! Whether you’re here to fix a bug, ship a feature, improve the docs, or just figure out how things work—we’re glad you’re here.
4
4
5
-
This short guide shows the fastest way to get your idea merged.
6
-
You can find more detailed contribution guides at [ag-ui.com](ag-ui.com)
5
+
Here’s how to get involved:
7
6
8
7
---
9
8
10
-
## 1. Start a Discussion
9
+
## 🤔 Have a Question or Ran Into Something?
11
10
12
-
Before writing code, open a new **Discussion** and briefly cover:
11
+
Pick the right spot so we can help you faster:
13
12
14
-
1.**Problem** – what you’re trying to solve.
15
-
2.**Proposal** – how you plan to solve it (code, docs, design, etc.).
16
-
3.**Alternatives** – other options you considered.
17
-
18
-
Early feedback keeps everyone aligned and saves re-work.
[](https://go.copilotkit.ai/ag-ui-build-an-agent-canvas)
1
+
2
+
# <imgsrc="https://github.com/user-attachments/assets/ebc0dd08-8732-4519-9b6c-452ce54d8058"alt="ag-ui Logo"width="45"/> AG-UI: The Agent-User Interaction Protocol
3
+
4
+
AG-UI is a lightweight, event-based protocol that standardizes how AI agents connect to user-facing applications.
5
+
Built for simplicity and flexibility, it enables seamless integration between AI agents, realtime user context, and user interfaces.
# <imgsrc="https://github.com/user-attachments/assets/ebc0dd08-8732-4519-9b6c-452ce54d8058"alt="ag-ui Logo"width="45"/> AG-UI: The Agent-User Interaction Protocol
6
-
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.
## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
123
+
## 🧩 AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
91
124
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)).
92
125
93
126
The building blocks are designed to be simple and focused -- between 50-200 lines of code.
The Python SDK for the [AgentUser Interaction Protocol](https://ag-ui.com).
3
+
Python SDK for the **Agent-User Interaction (AG-UI) Protocol**.
4
4
5
-
For more information visit the [official documentation](https://docs.ag-ui.com/).
5
+
`ag-ui-protocol` provides Python developers with strongly-typed data structures and event encoding for building AG-UI compatible agent servers. Built on Pydantic for robust validation and automatic camelCase serialization for seamless frontend integration.
6
+
7
+
## Installation
8
+
9
+
```bash
10
+
pip install ag-ui-protocol
11
+
poetry add ag-ui-protocol
12
+
pipenv install ag-ui-protocol
13
+
```
14
+
15
+
## Features
16
+
17
+
- 🐍 **Python-native** – Idiomatic Python APIs with full type hints and validation
0 commit comments