agui-dotnet-sample-step

AG-UI .NET — Add a GettingStarted Sample Step

The samples/GettingStarted/Step01..StepNN pairs are the primary consumer-facing deliverable: each Step is a self-contained Server + Client that demonstrates one feature, written to look like the code we want users to write. Adding a Step is a recurring, multi-artifact task. This skill covers the sample anatomy and wiring; it routes the integration-test mechanics to agui-dotnet-integration-tests and the doc sync to agui-dotnet-agents-sync.

Run all commands from sdks/dotnet/. Confirm the next free number and the current naming by listing samples/GettingStarted/Step* first — never assume the range.

Anatomy of a Step

A Step is a folder samples/GettingStarted/StepNN_<Name>/ with two projects:

• StepNN_<Name>.Server — an ASP.NET host (Microsoft.NET.Sdk.Web, net10.0). Program.cs calls builder.Services.AddAGUI(), registers an IChatClient, and ends with app.MapAGUI("/"). The IChatClient is the whole point: the SDK turns any IChatClient into an AG-UI endpoint, so the sample logic is just MEAI.

  • References src/AGUI.Abstractions + samples/AGUI.Samples.Shared (the ASP.NET glue). It does not reference an src/ server package directly.
  • InternalsVisibleTo the integration-test project so its replay test can reach the server's Program and any FakeChatClient.
  • Provide a deterministic FakeChatClient fallback (fixed clocks, canned tool results) used when no real LLM is configured. Replayable determinism is what lets the integration test record once and replay forever.

• StepNN_<Name>.Client — a console app (Microsoft.NET.Sdk, OutputType Exe, net10.0). Program.cs builds the client and hands it to a shared SampleClient:

  using HttpClient httpClient = new() { BaseAddress = new Uri(baseUrl) };
  var aguiClient = new AGUIChatClient(new(httpClient, baseUrl));
  await SampleClient.RunAsync(aguiClient, Console.Out);