Skip to content

Commit 129c3a9

Browse files
Merge branch 'main' into litebox-readme-update
2 parents 94023f8 + 0831f86 commit 129c3a9

36 files changed

+789
-131
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @mme @ranst91 @ataibarkai @maxkorp @tylerslaton
1+
* @mme @ranst91 @ataibarkai @maxkorp @tylerslaton @NathanTarbert

CONTRIBUTING.md

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,71 @@
1-
# Contributing to AG-UI
1+
# 👋 Contributing to AG-UI
22

3-
Thanks for your interest in improving **AG-UI**!
3+
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.
44

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:
76

87
---
98

10-
## 1. Start a Discussion
9+
## 🤔 Have a Question or Ran Into Something?
1110

12-
Before writing code, open a new **Discussion** and briefly cover:
11+
Pick the right spot so we can help you faster:
1312

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.
13+
- **🐛 Bugs / Feature Ideas**[GitHub Issues](https://github.com/ag-ui-protocol/ag-ui/issues)
14+
- **❓ "How do I...?" / General Questions**[GitHub Discussions](https://github.com/ag-ui-protocol/ag-ui/discussions)
15+
- **💬 Quick chats / casual stuff**[Discord](https://discord.gg/Jd3FzfdJa8)`#-💎-contributing`
1916

2017
---
2118

22-
## 2. Join a Bi-Weekly Working Group
19+
## 🧑‍💻 Want to Contribute Code?
2320

24-
Meet the team and potential collaborators in our [bi-weekly community call](https://lu.ma/calendar/manage/cal-DBw2gK428IQbiSO).
21+
1. **Find Something to Work On**
22+
Browse open issues on [GitHub](https://github.com/ag-ui-protocol/ag-ui/issues).
23+
Got your own idea? Open an issue first so we can start the discussion.
2524

26-
---
25+
2. **Ask to Be Assigned**
26+
Comment on the issue and tag a code owner:
27+
[Code Owners](https://github.com/ag-ui-protocol/ag-ui/blob/main/.github/CODEOWNERS)
28+
29+
3. **Get on the Roadmap**
30+
Once approved, you'll be assigned the issue, and it'll get added to our [roadmap](https://github.com/orgs/ag-ui-protocol/projects/1).
2731

28-
## 3. Connect with the Maintainers
32+
4. **Coordinate With Others**
33+
- If you're collaborating or need feedback, start a thread in `#-💎-contributing` on Discord
34+
- Or just DM the assignee directly
2935

30-
Need a quick sync?
36+
5. **Open a Pull Request**
37+
- When you’re ready, submit your PR
38+
- In the description, include: `Fixes #<issue-number>`
39+
(This links your PR to the issue and closes it automatically)
3140

32-
- **Markus:** [@mme_xyz](https://twitter.com/mme_xyz) on X (Twitter)
33-
- **Book a chat:** <https://calendly.com/markus-copilotkit/ag-ui>
41+
6. **Review & Merge**
42+
- A maintainer will review your code and leave comments if needed
43+
- Once it’s approved, we’ll merge it and move the issue to “done.”
3444

3545
---
3646

37-
## 4. Useful Resources & Docs
47+
## 📝 Want to Contribute to the Docs?
3848

39-
| Resource | Link |
40-
| ----------------------------------------- | -------------------------------------------------------- |
41-
| Learn how to connect to AG-UI with JS | <https://docs.ag-ui.com/quickstart/connect> |
42-
| Learn how to connect to AG-UI with Python | <https://docs.ag-ui.com/quickstart/build> |
43-
| Dojo reference implementation | <https://github.com/ag-ui-protocol/ag-ui/tree/main/dojo> |
49+
Docs are part of the codebase and super valuable—thanks for helping improve them!
4450

45-
---
51+
Here’s how to contribute:
52+
53+
1. **Open an Issue First**
54+
- Open a [GitHub issue](https://github.com/ag-ui-protocol/ag-ui/issues) describing what you’d like to update or add.
55+
- Then comment and ask to be assigned.
4656

47-
## 5. Open Your Pull Request
57+
2. **Submit a PR**
58+
- Once assigned, make your edits and open a pull request.
59+
- In the description, include: `Fixes #<issue-number>`
60+
(This links your PR to the issue and closes it automatically)
4861

49-
1. **Fork** the repo and create a feature branch.
50-
2. Keep changes focused—one PR per feature or fix.
51-
3. Link back to your Discussion in the PR description.
62+
- A maintainer will review it and merge if it looks good.
5263

53-
We review PRs weekly. Feel free to nudge us in your Discussion if you haven’t heard back in a few days.
64+
That’s it! Simple and appreciated.
5465

5566
---
5667

57-
**Thank you for making AG-UI better!**
68+
## 🙌 That’s It!
69+
70+
AG-UI is community-built, and every contribution helps shape where we go next.
71+
Big thanks for being part of it!

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ It also ships with a **reference HTTP implementation** and **default connector**
4444
AG-UI was developed based on real-world requirements and practical experience building in-app agent interactions.
4545

4646

47-
4847
## Where does AGUI fit in the agentic protocol stack?
4948
AG-UI is complementary to the other 2 top agentic protocols
5049
- MCP gives agents tools
5150
- A2A allows agents to communicate with other agents
5251
- AG-UI brings agents into user-facing applications
52+
5353

5454
## 🚀 Features
5555

python-sdk/README.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,57 @@
1-
# Agent User Interaction Protocol Documentation
1+
# ag-ui-protocol
22

3-
The Python SDK for the [Agent User Interaction Protocol](https://ag-ui.com).
3+
Python SDK for the **Agent-User Interaction (AG-UI) Protocol**.
44

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
18+
- 📋 **Pydantic models** – Runtime validation and automatic JSON serialization
19+
- 🔄 **Streaming events** – 16 core event types for real-time agent communication
20+
-**High performance** – Efficient event encoding for Server-Sent Events
21+
22+
## Quick example
23+
24+
```python
25+
from ag_ui.core import TextMessageContentEvent, EventType
26+
from ag_ui.encoder import EventEncoder
27+
28+
# Create a streaming text event
29+
event = TextMessageContentEvent(
30+
type=EventType.TEXT_MESSAGE_CONTENT,
31+
message_id="msg_123",
32+
delta="Hello from Python!"
33+
)
34+
35+
# Encode for HTTP streaming
36+
encoder = EventEncoder()
37+
sse_data = encoder.encode(event)
38+
# Output: data: {"type":"TEXT_MESSAGE_CONTENT","messageId":"msg_123","delta":"Hello from Python!"}\n\n
39+
```
40+
41+
## Packages
42+
43+
- **`ag_ui.core`** – Types, events, and data models for AG-UI protocol
44+
- **`ag_ui.encoder`** – Event encoding utilities for HTTP streaming
45+
46+
## Documentation
47+
48+
- Concepts & architecture: [`docs/concepts`](https://docs.ag-ui.com/concepts/architecture)
49+
- Full API reference: [`docs/sdk/python`](https://docs.ag-ui.com/sdk/python/core/overview)
50+
51+
## Contributing
52+
53+
Bug reports and pull requests are welcome! Please read our [contributing guide](https://docs.ag-ui.com/development/contributing) first.
54+
55+
## License
56+
57+
MIT © 2025 AG-UI Protocol Contributors

python-sdk/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "ag-ui-protocol"
3-
version = "0.1.7"
3+
version = "0.1.8"
44
description = ""
55
authors = ["Markus Ecker <[email protected]>"]
66
readme = "README.md"
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# @ag-ui/agno
2+
3+
Implementation of the AG-UI protocol for Agno.
4+
5+
Connects Agno agents to frontend applications via the AG-UI protocol using HTTP communication.
6+
7+
## Installation
8+
9+
```bash
10+
npm install @ag-ui/agno
11+
pnpm add @ag-ui/agno
12+
yarn add @ag-ui/agno
13+
```
14+
15+
## Usage
16+
17+
```ts
18+
import { AgnoAgent } from "@ag-ui/agno";
19+
20+
// Create an AG-UI compatible agent
21+
const agent = new AgnoAgent({
22+
url: "https://your-agno-server.com/agent",
23+
headers: { Authorization: "Bearer your-token" },
24+
});
25+
26+
// Run with streaming
27+
const result = await agent.runAgent({
28+
messages: [{ role: "user", content: "Hello from Agno!" }],
29+
});
30+
```
31+
32+
## Features
33+
34+
- **HTTP connectivity** – Direct connection to Agno agent servers
35+
- **Multi-agent support** – Works with Agno's multi-agent system architecture
36+
- **Streaming responses** – Real-time communication with full AG-UI event support

typescript-sdk/integrations/agno/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
{
22
"name": "@ag-ui/agno",
33
"author": "Manu Hortet <[email protected]>",
4-
"version": "0.0.1",
4+
"version": "0.0.2",
55
"main": "./dist/index.js",
66
"module": "./dist/index.mjs",
77
"types": "./dist/index.d.ts",
88
"sideEffects": false,
99
"files": [
10-
"dist/**"
10+
"dist/**",
11+
"README.md"
1112
],
1213
"private": false,
1314
"publishConfig": {
Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
1-
# Server Starter
1+
# @ag-ui/crewai
22

3-
This starter kit demonstrates sending the minimal set of events that are needed to stream data from the agent to the frontend.
3+
Implementation of the AG-UI protocol for CrewAI.
44

5-
## Running the server
5+
Connects CrewAI Flows and Crews to frontend applications via the AG-UI protocol. Supports both TypeScript HTTP clients and Python FastAPI server integration with streaming crew execution.
66

7-
To run the server:
7+
## Installation
88

99
```bash
10-
cd typescript-sdk/integrations/server-starter/server/python
10+
npm install @ag-ui/crewai
11+
pnpm add @ag-ui/crewai
12+
yarn add @ag-ui/crewai
13+
```
14+
15+
## Usage
16+
17+
```ts
18+
import { CrewAIAgent } from "@ag-ui/crewai";
19+
20+
// Create an AG-UI compatible agent
21+
const agent = new CrewAIAgent({
22+
url: "http://localhost:8000/crew-endpoint",
23+
headers: { "Content-Type": "application/json" },
24+
});
25+
26+
// Run with streaming
27+
const result = await agent.runAgent({
28+
messages: [{ role: "user", content: "Execute the research crew" }],
29+
});
30+
```
31+
32+
## Features
33+
34+
- **HTTP connectivity** – Connect to CrewAI FastAPI servers
35+
- **Flow & Crew support** – Works with both CrewAI Flows and traditional Crews
36+
- **Step tracking** – Real-time crew execution progress
37+
- **Python integration** – Full FastAPI server implementation included
1138

39+
## To run the example server in the dojo
40+
41+
```bash
42+
cd typescript-sdk/integrations/crewai/python
1243
poetry install && poetry run dev
1344
```

typescript-sdk/integrations/crewai/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
{
22
"name": "@ag-ui/crewai",
33
"author": "Markus Ecker <[email protected]>",
4-
"version": "0.0.1",
4+
"version": "0.0.2",
55
"main": "./dist/index.js",
66
"module": "./dist/index.mjs",
77
"types": "./dist/index.d.ts",
88
"sideEffects": false,
99
"files": [
10-
"dist/**"
10+
"dist/**",
11+
"README.md"
1112
],
1213
"private": false,
1314
"publishConfig": {
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# ag-ui-crewai
2+
3+
Implementation of the AG-UI protocol for CrewAI.
4+
5+
Provides a complete Python integration for CrewAI flows and crews with the AG-UI protocol, including FastAPI endpoint creation and comprehensive event streaming.
6+
7+
## Installation
8+
9+
```bash
10+
pip install ag-ui-crewai
11+
```
12+
13+
## Usage
14+
15+
```python
16+
from crewai.flow.flow import Flow, start
17+
from litellm import completion
18+
from ag_ui_crewai import (
19+
add_crewai_flow_fastapi_endpoint,
20+
copilotkit_stream,
21+
CopilotKitState
22+
)
23+
from fastapi import FastAPI
24+
25+
class MyFlow(Flow[CopilotKitState]):
26+
@start()
27+
async def chat(self):
28+
response = await copilotkit_stream(
29+
completion(
30+
model="openai/gpt-4o",
31+
messages=[
32+
{"role": "system", "content": "You are a helpful assistant."},
33+
*self.state.messages
34+
],
35+
tools=self.state.copilotkit.actions,
36+
stream=True
37+
)
38+
)
39+
self.state.messages.append(response.choices[0].message)
40+
41+
# Add to FastAPI
42+
app = FastAPI()
43+
add_crewai_flow_fastapi_endpoint(app, MyFlow(), "/flow")
44+
```
45+
46+
## Features
47+
48+
- **Native CrewAI integration** – Direct support for CrewAI flows, crews, and multi-agent systems
49+
- **FastAPI endpoint creation** – Automatic HTTP endpoint generation with proper event streaming
50+
- **Predictive state updates** – Real-time state synchronization between backend and frontend
51+
- **Streaming tool calls** – Live streaming of LLM responses and tool execution to the UI
52+
53+
## To run the dojo examples
54+
55+
```bash
56+
cd python/ag_ui_crewai
57+
poetry install
58+
poetry run dev
59+
```

0 commit comments

Comments
 (0)