.NET - AG-UI forwarded properties do not work

[jcageman]

agent-framework/dotnet/src/Microsoft.Agents.AI.AGUI/Shared/RunAgentInput.cs

Line 35 in 907d79a

[JsonPropertyName("forwardedProperties")]

    [JsonPropertyName("forwardedProperties")] // should be "forwardedProps"
    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
    public JsonElement ForwardedProperties { get; set; }

example payload from an ag-ui client:
{"threadId":"1c8a8631-5c2b-4c40-bb51-44d17f7110e5","runId":"e6a7101f-f26d-4730-9b08-6a0b30b4ab2e","tools":[],"context":[],"forwardedProps":{"customprop":"testid"},"state":{},"messages":[{"id":"98657e76-0796-463d-ac6c-9dbe638e7ec5","role":"user","content":"hi"},{"id":"3a638034-c8ed-4a9c-88c7-269e67bf1c5a","role":"assistant","content":"Hello, gentle soul, who greets me here, \nUpon this digital frontier. \nWith words so soft your presence grows— \nWhat brings you here? Please let me know."},{"id":"fdf7af48-e306-43b5-a6e4-aa3711f46ffb","role":"user","content":"k"},{"id":"ef907c12-cce9-410d-b2fa-d4488ec61685","role":"assistant","content":"One letter sent, concise and small, \nYet in its shape, I see it all— \nA quiet nod, a gentle wave, \nA secret sign, both terse and brave. \nThough brief, your message still has weight, \nA whispered pause—anticipate."},{"id":"0919529c-4aa1-449a-a051-7e8aff20bff6","role":"user","content":"k"}]}

https://docs.ag-ui.com/llms-full.txt

[javiercn]

@jcageman thanks for contacting us.

Can you clarify what you mean with "they don't work"? The forwarded properties are exposed as AdditionalProperties in ChatOptions https://github.com/microsoft/agent-framework/blob/main/dotnet/src/Microsoft.Agents.AI.Hosting.AGUI.AspNetCore/AGUIEndpointRouteBuilderExtensions.cs#L55-L61

You can access them in the following key "ag_ui_forwarded_properties". You can use a DelegatingAIAgent to read the properties and take any action you need based on that.

See an example (it's for accessing the state, but it's the same for forwarded properties):

agent-framework/dotnet/samples/AGUIClientServer/AGUIDojoServer/SharedStateAgent.cs

Lines 33 to 34 in e769256

	if (options is not ChatClientAgentRunOptions { ChatOptions.AdditionalProperties: { } properties } chatRunOptions ||
	!properties.TryGetValue("ag_ui_state", out JsonElement state))

[jcageman]

As mentioned the property in the json sent by an ag-ui frontend is called "forwardedProps", currently the implementation mentioned above expects "forwardedProperties". See: https://docs.ag-ui.com/sdk/js/core/types#runagentinput Clear?

[javiercn]

Thanks for the clarification. I was missing what was going on. I have prepared a PR with the fix