Skip to content

Commit 722407f

Browse files
committed
chore(ag-ui): add adapter-ag-ui to docs group
Add adapter-ag-ui to the documentation group in the project so mkdocs has access to the module and can generate the documentation. Some improvements to the ag-ui documentation were also made.
1 parent edbb712 commit 722407f

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

docs/ag-ui.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,23 @@ You can run the example with:
5050
uvicorn agent_to_ag_ui:app --host 0.0.0.0 --port 8000
5151
```
5252

53-
This will expose the agent as an AG-UI server, and you can start sending requests to it.
54-
55-
See more about [exposing PydanticAI agents as AG-UI servers](#pydanticai-agent-to-ag-ui-server).
53+
This will expose the agent as an AG-UI server, and you can start sending
54+
requests to it.
5655

5756
## Adapter AG UI
5857

59-
**AdapterAGUI** is an adapter between PydanticAI agents and the AG-UI protocol
60-
written in Python.
58+
[AdapterAGUI][adapter_ag_ui.AdapterAGUI]is an adapter between PydanticAI agents
59+
and the AG-UI protocol written in Python.
6160

6261
### Design
6362

6463
The adapter receives messages in the form of a
65-
[`RunAgentInput.state`](https://docs.ag-ui.com/sdk/js/core/types#runagentinput)
64+
[`RunAgentInput`](https://docs.ag-ui.com/sdk/js/core/types#runagentinput)
6665
which describes the details of a request being passed to the agent including
67-
messages and state. These are then translated to PydanticAI types, passed to the
68-
provided agent when then process the request. Results from the agent are then
69-
streamed back to the caller.
66+
messages and state. These are then converted to PydanticAI types, passed to the
67+
provided agent which then process the request. Results from the agent are
68+
converted from PydanticAI types to AG-UI events and streamed back to the caller
69+
as Server-Sent Events (SSE).
7070

7171
A user request may require multiple round trips between client UI and PydanticAI
7272
server, depending on the tools and events needed.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ members = [
8686
# dev dependencies are defined in `pydantic-ai-slim/pyproject.toml` to allow for minimal testing
8787
lint = ["mypy>=1.11.2", "pyright>=1.1.390", "ruff>=0.6.9"]
8888
docs = [
89+
"adapter-ag-ui>=0.3.4",
8990
"black>=24.10.0",
9091
"mkdocs>=1.6.1",
9192
"mkdocs-glightbox>=0.4.0",

uv.lock

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)