Expand AG-UI adapter documentation#17
Open
lussoluca wants to merge 1 commit into
Open
Conversation
Document how to connect a real AG-UI frontend to the adapter: the RunAgentInput request payload, passing the client's threadId and runId to the adapter constructor, sending the SSE headers from getHeaders() and flushing the output, a complete endpoint example, the table of emitted events per Neuron chunk type, and the current limits (server side tool execution only, no shared state events). Refs: neuron-core/neuron-ai#607 Assisted-by: claude-code/claude-fable-5
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
1 participant
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.
Refs neuron-core/neuron-ai#607
Summary
The AG-UI adapter section of the streaming page currently shows only the bare adapter instantiation. A real AG-UI frontend sends a
RunAgentInputPOST body and expects its ownthreadIdandrunIdechoed back in the lifecycle events, so a reader following the current example ends up with an endpoint that AG-UI clients cannot correlate runs with.This PR expands the section with:
RunAgentInputrequest payload an AG-UI client sends.threadIdandrunIdto the adapter constructor so they are echoed inRUN_STARTEDandRUN_FINISHED.getHeaders()and flushing output after each line.@ag-ui/coreandag-ui-protocolSDK validators).RunAgentInput.toolsare not handled) and shared state events are not emitted.Note
The
runIdconstructor argument documented here is introduced in neuron-core/neuron-ai#608. This PR should be merged after that one.