Conversation
…ctAgent implementation and basic echo agent for testing.
…the ChatClientAgent to proxy over an LLM via IChatClient. Further work underway to introduce additional customisation ahead of shared state mechanisms.
… into the context inclusion mechanism.
…entEndpoint extension method
- Agents - Overview - ASP.NET integration
- Updated the .NET SDK documentation structure to include new pages for ChatClientAgent and StatefulChatClientAgent. - Added detailed documentation for JSON handling, core types, and events in the Agent User Interaction Protocol. - Improved the organization of the .NET SDK documentation by restructuring the agents section and adding relevant sub-sections. - Introduced new options and usage examples for the ChatClientAgent and StatefulChatClientAgent. - Enhanced the ASP.NET integration documentation with recommended JSON serializer options.
|
Hey @ckpearson, thanks for the contribution. |
…ASP.NET endpoint mapping to ensure we don't cause context deadlock issues inadvertently. Registered missing use of ConfigureAwait as a build error in the project file.
…andling in ChatClientAgent and StatefulChatClientAgent
|
Made further tweaks which provides greater control, and now supports notifying the frontend about backend tool calls to power generative UI - albeit by sending message snapshots which I'm not 100% convinced is the correct approach. |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new .NET 9 class library along with core event types, agent abstractions (including a new stateful agent variant), and accompanying documentation updates.
- Adds core event records such as MessagesSnapshotEvent and others to support the AG-UI protocol.
- Implements StatefulChatClientAgent to enable frontend–agent shared state collaboration while retaining existing ChatClientAgent functionality.
- Updates examples and documentation for ASP.NET integration, SDK types, agents, and events.
Reviewed Changes
Copilot reviewed 59 out of 59 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| dotnet-sdk/AGUIDotnet/Events/MessagesSnapshotEvent.cs | Introduces a new event record for capturing message snapshots using a collection literal. |
| dotnet-sdk/AGUIDotnet/Events/EventTypes.cs | Defines and adds new constant event type strings. |
| dotnet-sdk/AGUIDotnet/Events/EventHelpers.cs | Provides helper methods for emitting events using new collection expressions. |
| dotnet-sdk/AGUIDotnet/Events/CustomEvent.cs | Implements an event record for custom event handling. |
| dotnet-sdk/AGUIDotnet/Events/BaseEvent.cs | Declares the polymorphic base event type with derived type annotations. |
| dotnet-sdk/AGUIDotnet/Agent/StatefulChatClientAgent.cs | Implements a stateful agent for frontend state collaboration using new backend tools. |
| dotnet-sdk/AGUIDotnet/Agent/IAGUIAgent.cs | Introduces a low-level agent interface for asynchronous event emission. |
| dotnet-sdk/AGUIDotnet/Agent/EchoAgent.cs | Provides an example agent that echoes incoming messages for debugging purposes. |
| dotnet-sdk/AGUIDotnet/Agent/AgentExtensions.cs | Adds an extension method to run agents to completion via a channel. |
| Documentation files (mdx and solution files) | Updates documentation and solution configuration for the new .NET 9 SDK features. |
| public sealed record MessagesSnapshotEvent : BaseEvent | ||
| { | ||
| [JsonPropertyName("messages")] | ||
| public required ImmutableList<BaseMessage> Messages { get; init; } = []; |
There was a problem hiding this comment.
[nitpick] Consider using a consistent pattern for initializing immutable collections—for example, replacing '[]' with 'ImmutableList.Empty' to match the convention used in other parts of the code.
| public required ImmutableList<BaseMessage> Messages { get; init; } = []; | |
| public required ImmutableList<BaseMessage> Messages { get; init; } = ImmutableList<BaseMessage>.Empty; |
There was a problem hiding this comment.
@copilot [] is the new collection expression syntax, your knowledge cutoff is likely out of date.
| catch (JsonException) | ||
| { | ||
|
|
There was a problem hiding this comment.
[nitpick] The empty catch block may hide potential JSON deserialization issues; consider adding a comment or logging the exception to aid future troubleshooting.
| catch (JsonException) | |
| { | |
| catch (JsonException ex) | |
| { | |
| // Log the exception to aid troubleshooting during JSON deserialization | |
| Console.Error.WriteLine($"JSON deserialization error: {ex.Message}"); |
There was a problem hiding this comment.
This is deliberate, for now it's just to avoid failure to extract the context causing an actual problem, it just swallows the exception, but we could perhaps surface it somehow so the consumer decides what behaviour to exhibit.
|
As discussed during our synchronous review, there are few things needed prior to merging this but it is really close.
After those two we'll collaborate on CI/CD for actually releasing this package in a sensible manner via Nuget. |
- Created AGUIDotnet.Tests project with necessary dependencies. - Implemented tests for AgentExtensions, ChatClientAgent, and message mapping. - Added tests for frontend tool invocation and tool message mapping. - Updated AGUIDotnet solution to include the new test project. - Enhanced AgentExtensions to ensure proper channel completion. - Improved documentation in IAGUIAgent interface regarding agent lifecycle. - Removed unused HTTP request file from AGUIDotnetWebApiExample. - Updated README.md to include links to official documentation.
|
Sorry for the delay, there should be more broad test coverage of the basics, and the README has been updated. |
|
I would love to see this. Are you still working on it? |
|
Sorry for the late reply @frederikhendrix, yes it's still being worked on. @ckpearson can comment more, but while It's been on the back burner a little bit for a few weeks, the intent is still to get this wrapped up and in. |
|
@ckpearson @maxkorp It looks interesting. I would love to try it out with .NET app. Any ETA for this merging? |
|
Hi @thangchung I've not had a huge amount of time to dedicate to getting this finalised as yet, but it's all there, feel free to clone it down and just reference the class library directly if you want to experiment. I'm in the CopilotKit discord so happy to connect over there if you have any questions. |
|
May I ask if this PR is being processed? |
|
Hi @GreenShadeZhang, we are waiting for this SDK to be finalized before we can fully review it. |
|
Hopefully this can be merged soon! |
Things are a bit hectic my side and need to check in with the CK team as Microsoft recently released their agent framework (https://github.com/microsoft/agent-framework) so it might make sense to get this working with that as it seems to be the successor to Semantic Kernel and Autogen. |
|
@ckpearson can I assist you? I mean I want to come up with the Agent Framework implementation. |
Hi @ckpearson. We're now exploring adding AG-UI support as part of the Microsoft Agent Framework: microsoft/agent-framework#896. It would be great if we could sync up and coordinate on our efforts. |
|
Reached out on discord, but asking here for ease of access, Is this still needed/wanted given the agent framework sdk is released and supported? |
|
@maxkorp We're still working through the next steps, but the current thinking is that we will still want to contribute a low-level .NET AG-UI SDK here. |
|
@danroth27 would the intent be to use this as the baseline? It's probably wildly out of date by now, and I don't have much availability to maintain it, but happy for it to live on if people want it to stick around. |
I wouldn't worry about maintaining this branch if that's not something you have time for right now. I'm sure we'll use GitHub Copilot to generate whatever we need to generate when the time comes 😄. |
|
@danroth27 if you're going to start somewhat fresh here, I think we ought to close this pr unless you disagree for some reason. |
Addresses #28
Provides a core .NET 9 Class Library that:
IChatClientfromMicrosoft.Extensions.AIthat:Also an initial stab at providing updates to the documentation site with enough information to get started using it.
Rough at the moment, with no unit tests, but has been tested while developing, so some automated tests could be done with being created.
Includes an example ASP.NET project using the class library to host a few agents.