Skip to content

Commit 7153409

Browse files
Merge branch 'main' into more_sentinel_fixes
2 parents ecf6d12 + 6e55115 commit 7153409

File tree

1 file changed

+46
-23
lines changed

1 file changed

+46
-23
lines changed

README.md

Lines changed: 46 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,22 @@ _Automate your web tasks while you stay in control_
77
[![image](https://img.shields.io/pypi/v/magentic_ui.svg)](https://pypi.python.org/pypi/magentic_ui)
88
[![image](https://img.shields.io/pypi/l/magentic_ui.svg)](https://pypi.python.org/pypi/magentic_ui)
99
![Python Versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
10+
[![arXiv](https://img.shields.io/badge/arXiv-2507.22358-b31b1b.svg)](https://arxiv.org/abs/2507.22358)
1011

1112
</div>
1213

1314
---
1415

15-
Magentic-UI is a **research prototype** of a human-centered interface powered by a multi-agent system that can browse and perform actions on the web, generate and execute code, and generate and analyze files.
16+
Magentic-UI is a **research prototype** human-centered AI agent that solves complex web and coding tasks that may require monitoring. Unlike other black-box agents, the system reveals its plan before executions, lets you guide its actions, and requests approval for sensitive operations while browsing websites, executing code, and analyzing files.
17+
*Check out the [demo section](#demos) for inspiration on what tasks you can accomplish.*
18+
19+
## ✨ What's New
20+
21+
- **"Tell me When"**: Automate monitoring tasks and repeatable workflows that require web or API access that span minutes to days. *Learn more [here](https://www.microsoft.com/en-us/research/?p=1152051&preview=1&_ppp=a53d9c1d19).*
22+
- **File Upload Support**: Upload any file through the UI for analysis or modification
23+
- **MCP Agents**: Extend capabilities with your favorite MCP servers
24+
- **Easier Installation**: We have uploaded our docker containers to GHCR so you no longer need to build any containers! Installation time now is much quicker.
1625

17-
https://github.com/user-attachments/assets/7975fc26-1a18-4acb-8bf9-321171eeade7
1826

1927
## 🚀 Quick Start
2028

@@ -37,12 +45,6 @@ Then open <http://localhost:8081> in your browser to interact with Magentic-UI!
3745

3846
> **Prerequisites**: Requires Docker and Python 3.10+. Windows users should use WSL2. See [detailed installation](#️-installation) for more info.
3947
40-
## ✨ What's New
41-
42-
- **File Upload Support**: Upload any file through the UI for analysis or modification
43-
- **MCP Agents**: Extend capabilities with your favorite MCP servers
44-
- **Easier Installation**: We have uploaded our docker containers to GHCR so you no longer need to build any containers! Installation time now is much quicker.
45-
4648
## Alternative Usage Options
4749

4850
**Without Docker** (limited functionality: no code execution):
@@ -70,37 +72,58 @@ For further details on installation please read the <a href="#️-installation
7072

7173
## Quick Navigation:
7274
<p align="center">
73-
<a href="#-how-it-works">🟪 How it Works</a> &nbsp;|&nbsp;
74-
<a href="#️-installation">🛠️ Installation</a> &nbsp;|&nbsp;
75+
<a href="#demos">🎬 Demos</a> &nbsp;|&nbsp;
76+
<a href="#how-it-works">🟪 How it Works</a> &nbsp;|&nbsp;
77+
<a href="#️installation">🛠️ Installation</a> &nbsp;|&nbsp;
7578
<a href="#troubleshooting">⚠️ Troubleshooting</a> &nbsp;|&nbsp;
7679
<a href="#contributing">🤝 Contributing</a> &nbsp;|&nbsp;
7780
<a href="#license">📄 License</a>
7881
</p>
7982

8083
---
8184

82-
## 🟪 How it Works
83-
<p align="center">
84-
<img src="./docs/img/magenticui_running.png" alt="Magentic-UI" height="400">
85-
</p>
85+
## Demos
8686

87-
Magentic-UI is especially useful for web tasks that require actions on the web (e.g., filling a form, customizing a food order), deep navigation through websites not indexed by search engines (e.g., filtering flights, finding a link from a personal site) or tasks that need web navigation and code execution (e.g., generate a chart from online data).
87+
<table>
88+
<tr>
89+
<td width="33%" align="center">
90+
91+
**🍕 Pizza Ordering**
92+
*Web automation with human-in-the-loop*
93+
94+
<video src="https://github.com/user-attachments/assets/dc95cf5f-c4b4-4fe0-b708-158ff071e5a9" width="100%" style="max-height: 300px;">
95+
</video>
96+
97+
</td>
98+
<td width="33%" align="center">
8899

89-
The interface of Magentic-UI is displayed in the screenshot above and consists of two panels. The left side panel is the sessions navigator where users can create new sessions to solve new tasks, switch between sessions and check on session progress with the session status indicators (🔴 needs input, ✅ task done, ↺ task in progress).
100+
**🏠 Airbnb Price Analysis**
101+
*MCP agent integration*
90102

91-
The right-side panel displays the session selected. This is where you can type your query to Magentic-UI alongside any file attachments and observe detailed task progress as well as interact with the agents. The session display itself is split in two panels: the left side is where Magentic-UI presents the plan, task progress and asks for action approvals, the right side is a browser view where you can see web agent actions in real time and interact with the browser. Finally, at the top of the session display is a progress bar that updates as Magentic-UI makes progress.
103+
<video src="https://github.com/user-attachments/assets/c19ed8c2-e06f-43b7-bee3-5e2ffc4c5e02" width="100%" style="max-height: 300px;">
104+
</video>
92105

106+
</td>
107+
<td width="33%" align="center">
93108

94-
The example below shows a step by step user interaction with Magentic-UI:
109+
**⭐ Star Monitoring**
110+
*Long-running monitoring task*
95111

96-
<!-- Screenshots -->
112+
<video src="https://github.com/user-attachments/assets/d2a463ca-7a94-4414-932d-a69f30fff63b" width="100%" style="max-height: 300px;">
113+
</video>
114+
115+
</td>
116+
</tr>
117+
</table>
118+
119+
120+
121+
## How it Works
97122
<p align="center">
98-
<img src="docs/img/magui-landing.png" alt="Magentic-UI Landing" width="45%" style="margin:10px;">
99-
<img src="docs/img/magui-coplanning.png" alt="Co-Planning UI" width="45%" style="margin:10px;">
100-
<img src="docs/img/magui-cotasking.png" alt="Co-Tasking UI" width="45%" style="margin:10px;">
101-
<img src="docs/img/magui-actionguard.png" alt="Action Guard UI" width="45%" style="margin:10px;">
123+
<img src="./docs/img/magenticui_running.png" alt="Magentic-UI" height="400">
102124
</p>
103125

126+
Magentic-UI is especially useful for web tasks that require actions on the web (e.g., filling a form, customizing a food order), deep navigation through websites not indexed by search engines (e.g., filtering flights, finding a link from a personal site) or tasks that need web navigation and code execution (e.g., generate a chart from online data).
104127

105128
What differentiates Magentic-UI from other browser use offerings is its transparent and controllable interface that allows for efficient human-in-the-loop involvement. Magentic-UI is built using [AutoGen](https://github.com/microsoft/autogen) and provides a platform to study human-agent interaction and experiment with web agents. Key features include:
106129

0 commit comments

Comments
 (0)