docs(ag-ui): comprehensive interface documentation#682
Open
Himanshu040604 wants to merge 7 commits into
Open
Conversation
…ple-instances recipes
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands and refreshes the AG-UI documentation set to provide a full interface guide (overview/setup/reference), updated usage recipes, navigation registration, and an updated deploy quickstart for running an AG-UI backend and connecting a frontend.
Changes:
- Added new AG-UI guide pages: Setup and Reference; rewrote the Introduction/Overview page with expanded sections (sessions/state, reasoning, structured output, tools, events, security, troubleshooting).
- Added/updated AG-UI usage recipes (including new pages for silent tools, reasoning agent, structured output, and multiple instances).
- Updated site navigation (
docs.json) and refreshed the AG-UI deploy overview (run command + next-step links).
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs.json | Registers AG-UI guide/recipe pages in the docs navigation. |
| deploy/interfaces/ag-ui/overview.mdx | Updates quickstart run instructions and next-step links for deploying/serving AG-UI. |
| agent-os/interfaces/ag-ui/introduction.mdx | Rewrites AG-UI overview docs with expanded guidance and troubleshooting. |
| agent-os/interfaces/ag-ui/setup.mdx | New setup walkthrough for running backend + connecting Dojo frontend. |
| agent-os/interfaces/ag-ui/reference.mdx | New reference page for parameters, endpoints, and event mapping. |
| agent-os/usage/interfaces/ag-ui/basic.mdx | Refreshes the basic AG-UI agent recipe (model/port/deps + frontend steps). |
| agent-os/usage/interfaces/ag-ui/agent-with-tools.mdx | Refreshes tools recipe to demonstrate backend + frontend tool execution. |
| agent-os/usage/interfaces/ag-ui/agent-with-silent-tools.mdx | New recipe showing silent external (frontend) tools. |
| agent-os/usage/interfaces/ag-ui/reasoning-agent.mdx | New recipe demonstrating streaming reasoning events to the frontend. |
| agent-os/usage/interfaces/ag-ui/structured-output.mdx | New recipe demonstrating Pydantic structured outputs over AG-UI. |
| agent-os/usage/interfaces/ag-ui/multiple-instances.mdx | New recipe showing multiple AG-UI instances via interface prefixes. |
| agent-os/usage/interfaces/ag-ui/team.mdx | Refreshes team recipe and frontend setup steps for AG-UI teams. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+15
to
+18
| chat_agent = Agent( | ||
| name="Assistant", | ||
| model=OpenAIResponses(id="o4-mini"), | ||
| instructions="You are a helpful AI assistant.", |
12 tasks
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Mustafa-Esoofally
added a commit
to agno-agi/agno
that referenced
this pull request
Jun 17, 2026
## Summary Update the AG-UI cookbook examples to the recommended OpenAI model setup: - Switch `OpenAIChat` to `OpenAIResponses` across all 7 examples. - Standardize model IDs to `gpt-5.4`. The reasoning example keeps `o4-mini`. - `multiple_instances.py`: serve on port 9001 for Dojo compatibility. - Trim a few over-stated tool descriptions and `MovieScript` field descriptions to match the documented examples. ## Type of change - [x] Model update - [x] Improvement --- ## Checklist - [x] Code complies with style guidelines - [x] Ran format/validation scripts - [x] Self-review completed - [ ] Documentation updated (comments, docstrings) - [x] Examples and guides: Relevant cookbook examples updated - [ ] Tested in clean environment - [ ] Tests added/updated (if applicable) ### Duplicate and AI-Generated PR Check - [x] I have searched existing open pull requests and confirmed no other PR addresses this - [ ] If a similar PR exists, I have explained below why this PR is a better approach - [ ] Check if this PR was entirely AI-generated --- ## Additional Notes Model-identifier updates and example-description trims only. Ran `ruff format` (no changes) and `ruff check` (passed) on the 7 files. The matching AG-UI documentation ships separately in agno-agi/docs#682. --------- Co-authored-by: Mustafa Esoofally <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Full AG-UI interface documentation: guide pages, usage recipes, and deploy.
Changes
Guide pages (
agent-os/interfaces/ag-ui/)introduction.mdx: rewritten to the interface format (example usage, sessions &state, reasoning, structured output, frontend tools, custom events, security/CORS,
troubleshooting)
setup.mdx(new): run the backend and connect a Dojo frontendreference.mdx(new): interface parameters, endpoints, and the Agno to AG-UI event mapRecipes (
agent-os/usage/interfaces/ag-ui/)basic,agent-with-tools,teamagent-with-silent-tools,reasoning-agent,structured-output,multiple-instancesNavigation: registered all AG-UI pages in
docs.json.Deploy (
deploy/interfaces/ag-ui/overview.mdx): fixed the run command(
python agui_agent.py) and refreshed the next-steps links.Notes
cookbook/05_agent_os/interfaces/agui/and uses
OpenAIResponses(id="gpt-5.4"). The reasoning example useso4-mini, anative reasoning model.