docs(ag-ui): add README with usage examples and CopilotKit integration#1352
docs(ag-ui): add README with usage examples and CopilotKit integration#1352nuthalapativarun wants to merge 2 commits into
Conversation
🦋 Changeset detectedLatest commit: da64e01 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 2 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
|
Fixed — added |
There was a problem hiding this comment.
3 issues found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="packages/ag-ui/README.md">
<violation number="1" location="packages/ag-ui/README.md:1">
P2: README starts with a UTF-8 BOM, which is an unintended encoding artifact inconsistent with the rest of the repository.</violation>
<violation number="2" location="packages/ag-ui/README.md:109">
P2: The em dash default marker is corrupted to `‗`, making the table look broken.</violation>
<violation number="3" location="packages/ag-ui/README.md:131">
P2: The copyright symbol is corrupted to `©`, making the license line look broken.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| @@ -0,0 +1,131 @@ | |||
| <div align="center"> | |||
There was a problem hiding this comment.
P2: README starts with a UTF-8 BOM, which is an unintended encoding artifact inconsistent with the rest of the repository.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At packages/ag-ui/README.md, line 1:
<comment>README starts with a UTF-8 BOM, which is an unintended encoding artifact inconsistent with the rest of the repository.</comment>
<file context>
@@ -1,4 +1,4 @@
-<div align="center">
+<div align="center">
<a href="https://voltagent.dev/">
<img width="1500" height="276" alt="voltagent" src="https://github.com/user-attachments/assets/d9ad69bd-b905-42a3-81af-99a0581348c0" />
</file context>
| <div align="center"> | |
| +<div align="center"> |
|
|
||
| ## License | ||
|
|
||
| Licensed under the MIT License, Copyright © 2026-present VoltAgent. |
There was a problem hiding this comment.
P2: The copyright symbol is corrupted to ©, making the license line look broken.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At packages/ag-ui/README.md, line 131:
<comment>The copyright symbol is corrupted to `©`, making the license line look broken.</comment>
<file context>
@@ -128,4 +128,4 @@ registerCopilotKitRoutes({
## License
-Licensed under the MIT License, Copyright © 2026-present VoltAgent.
+Licensed under the MIT License, Copyright © 2026-present VoltAgent.
</file context>
| Licensed under the MIT License, Copyright © 2026-present VoltAgent. | |
| Licensed under the MIT License, Copyright © 2026-present VoltAgent. |
|
|
||
| | Option | Type | Default | Description | | ||
| | ---------------- | ------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------- | | ||
| | `agents` | `Record<string, AbstractAgent>` | — | Static map of AG-UI agents | |
There was a problem hiding this comment.
P2: The em dash default marker is corrupted to ‗, making the table look broken.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At packages/ag-ui/README.md, line 109:
<comment>The em dash default marker is corrupted to `‗`, making the table look broken.</comment>
<file context>
@@ -106,17 +106,17 @@ registerCopilotKitRoutes({
| ---------------- | ------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------- |
-| `agents` | `Record<string, AbstractAgent>` | — | Static map of AG-UI agents |
-| `loadAgents` | `() => Promise<Record<string, AbstractAgent>> \| Record<string, AbstractAgent>` | — | Lazy loader; overrides `agents` if provided |
+| `agents` | `Record<string, AbstractAgent>` | — | Static map of AG-UI agents |
+| `loadAgents` | `() => Promise<Record<string, AbstractAgent>> \| Record<string, AbstractAgent>` | — | Lazy loader; overrides `agents` if provided |
| `serviceAdapter` | `CopilotServiceAdapter` | `ExperimentalEmptyAdapter` | CopilotKit service adapter |
</file context>
| | `agents` | `Record<string, AbstractAgent>` | — | Static map of AG-UI agents | | |
| | `agents` | `Record<string, AbstractAgent>` | — | Static map of AG-UI agents | |
1 participant
PR Checklist
<type>(<scope>): <description>)Bugs / Features
pnpm changeset)What is the current behavior?
@voltagent/ag-uihas no README, so users have no documentation for wrapping a VoltAgent agent as an AG-UI agent or exposing it through a CopilotKit runtime.What is the new behavior?
Adds a README covering installation, the
createVoltAgentAGUIadapter, and both CopilotKit integration helpers (createCopilotKitHandlerandregisterCopilotKitRoutes) with their options.Notes for reviewers
Mirrors the style/structure of the recently added
@voltagent/server-coreREADME (#1331).Summary by cubic
Adds a README for
@voltagent/ag-uiwith install and usage examples, including@voltagent/coreand@ai-sdk/openaiin the install commands. CoverscreateVoltAgentAGUI, CopilotKit integration viacreateCopilotKitHandler/registerCopilotKitRoutes, and documents options and AgentRegistry-based routing.Written for commit da64e01. Summary will update on new commits.
Summary by CodeRabbit
@voltagent/ag-uipackage, including installation steps, basic usage withcreateVoltAgentAGUI, configuration options, observable-based runtime behavior, and CopilotKit integration (handler setup and route registration).