Adapt to new breaking changes in AF and new registrations

kzu · kzu · commit 6128bed9fc85 · 2025-12-07T06:27:27.000-08:00
Instructions is gone from Agent, it's now only in agent's chat options.

Agent catalog is likewise gone, relying solely on DI keyed services.

Also, overload in MapOpenAIResponses receiving the agent is enough now to properly map responses.

DevUI mapped but conversations not working as it needs.

More tweaks needed, but this allows D.E.AI to build
diff --git a/sample/Server/AgentDiscoveryExtensions.cs b/sample/Server/AgentDiscoveryExtensions.cs
@@ -1,17 +1,15 @@
 ﻿using System.Diagnostics.CodeAnalysis;
 using System.Text.Json.Serialization;
-using Microsoft.Agents.AI.Hosting;
+using Microsoft.Agents.AI;
 
 static class AgentDiscoveryExtensions
 {
     public static void MapAgentDiscovery(this IEndpointRouteBuilder endpoints, [StringSyntax("Route")] string path)
     {
         var routeGroup = endpoints.MapGroup(path);
-        routeGroup.MapGet("/", async (AgentCatalog catalog, CancellationToken cancellation)
-            => Results.Ok(await catalog
-                .GetAgentsAsync(cancellation)
-                .Select(agent => new AgentDiscoveryCard(agent.Name!, agent.Description))
-                .ToArrayAsync()))
+        routeGroup.MapGet("/", () => Results.Ok(endpoints.ServiceProvider
+            .GetKeyedServices<AIAgent>(KeyedService.AnyKey)
+            .Select(agent => new AgentDiscoveryCard(agent.Name!, agent.Description)).ToArray()))
             .WithName("GetAgents");
     }
 
diff --git a/sample/Server/ConsoleExtensions.cs b/sample/Server/ConsoleExtensions.cs
@@ -1,6 +1,6 @@
 ﻿using Devlooped.Agents.AI;
 using Devlooped.Extensions.AI;
-using Microsoft.Agents.AI.Hosting;
+using Microsoft.Agents.AI;
 using Microsoft.Extensions.AI;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
@@ -13,7 +13,6 @@ public static class ConsoleExtensions
     {
         public async ValueTask RenderAgentsAsync(IServiceCollection collection)
         {
-            var catalog = services.GetRequiredService<AgentCatalog>();
             var settings = new JsonSerializerSettings
             {
                 NullValueHandling = NullValueHandling.Include,
@@ -38,14 +37,24 @@ public async ValueTask RenderAgentsAsync(IServiceCollection collection)
             }
 
             // List configured agents
-            await foreach (var agent in catalog.GetAgentsAsync())
+            var rendered = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+            foreach (var descriptor in collection.AsEnumerable().Where(x => x.ServiceType == typeof(AIAgent) && x.IsKeyedService && x.ServiceKey is string))
             {
+                if (rendered.Contains((string)descriptor.ServiceKey!))
+                    continue;
+
+                var agent = services.GetKeyedService<AIAgent>(descriptor.ServiceKey);
+                if (agent is null)
+                    continue;
+
                 var metadata = agent.GetService<ConfigurableAIAgentMetadata>();
 
                 AnsiConsole.Write(new Panel(new JsonText(JsonConvert.SerializeObject(new { Agent = agent, Metadata = metadata }, settings)))
                 {
                     Header = new PanelHeader($"| 🤖 {agent.DisplayName} from {metadata?.ConfigurationSection} |"),
                 });
+
+                rendered.Add((string)descriptor.ServiceKey!);
             }
         }
     }
diff --git a/sample/Server/DotEnv.cs b/sample/Server/DotEnv.cs
@@ -0,0 +1,16 @@
+﻿using System.Runtime.CompilerServices;
+
+class DotEnv
+{
+    [ModuleInitializer]
+    public static void Init()
+    {
+        // Load environment variables from .env files in current dir and above.
+        DotNetEnv.Env.TraversePath().Load();
+
+        // Load environment variables from user profile directory.
+        var userEnv = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".env");
+        if (File.Exists(userEnv))
+            DotNetEnv.Env.Load(userEnv);
+    }
+}
diff --git a/sample/Server/Program.cs b/sample/Server/Program.cs
@@ -2,8 +2,7 @@
 using System.Text;
 using Devlooped.Extensions.AI;
 using Microsoft.Agents.AI;
-using Microsoft.Agents.AI.Hosting;
-using Microsoft.Agents.AI.Hosting.OpenAI;
+using Microsoft.Agents.AI.DevUI;
 using Microsoft.Extensions.AI;
 using Spectre.Console;
 
@@ -34,6 +33,9 @@
 builder.AddAIAgents()
     .WithTools<NotesTools>();
 
+builder.AddOpenAIResponses();
+builder.AddOpenAIConversations();
+
 var app = builder.Build();
 
 // From ServiceDefaults.cs
@@ -42,15 +44,19 @@
 #if DEBUG
 // 👇 render all configured agents
 await app.Services.RenderAgentsAsync(builder.Services);
+app.MapDevUI();
 #endif
 
 // Map each agent's endpoints via response API
-var catalog = app.Services.GetRequiredService<AgentCatalog>();
 // List configured agents
-await foreach (var agent in catalog.GetAgentsAsync())
+var registered = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+foreach (var agent in app.Services.GetKeyedServices<AIAgent>(KeyedService.AnyKey))
 {
-    if (agent.Name != null)
-        app.MapOpenAIResponses(agent.Name);
+    if (agent.Name != null && !registered.Contains(agent.Name))
+    {
+        app.MapOpenAIResponses(agent);
+        registered.Add(agent.Name);
+    }
 }
 
 // Map the agents HTTP endpoints
diff --git a/sample/Server/Server.csproj b/sample/Server/Server.csproj
@@ -6,7 +6,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Agents.AI.Hosting.OpenAI" Version="42.42.11-pre" />
+    <PackageReference Include="Microsoft.Agents.AI.DevUI" Version="42.42.12-pre" />
+    <PackageReference Include="Microsoft.Agents.AI.Hosting.OpenAI" Version="42.42.12-pre" />
     <PackageReference Include="ModelContextProtocol" Version="0.4.0-preview.3" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.4" />
     <PackageReference Include="ThisAssembly.Project" Version="2.1.2" PrivateAssets="all" />
diff --git a/sample/Server/ai.toml b/sample/Server/ai.toml
@@ -7,20 +7,17 @@ modelid = "grok-4-fast-non-reasoning"
 
 [ai.agents.orders]
 description = "Manage orders using catalogs for food or any other item."
-instructions = """\
-    You are an AI agent responsible for processing orders for food or other items.
-    Your primary goals are to identify user intent, extract or request provider information, manage order data using tools and friendly responses to guide users through the ordering process.
-    """
-options = { modelid = "gpt-4o-mini" }
-# 👇 alternative syntax to specify options
-# [ai.agents.orders.options]
-# modelid = "gpt-4o-mini"
-
 # ai.clients.openai, can omit the ai.clients prefix
 client = "openai"
 use = ["tone"]
 tools = ["get_date", "create_order", "cancel_order"]
 
+[ai.agents.orders.options]
+modelid = "gpt-4o-mini"
+instructions = """
+    You are an AI agent responsible for processing orders for food or other items.
+    Your primary goals are to identify user intent, extract or request provider information, manage order data using tools and friendly responses to guide users through the ordering process.
+    """
 
 [ai.context.tone]
 instructions = """\
diff --git a/sample/Server/notes.agent.md b/sample/Server/notes.agent.md
@@ -4,7 +4,8 @@ description: Provides free-form memory
 beta: true
 visibility: unlisted
 client: grok
-model: grok-4-fast
+options:
+  modelid: grok-4-fast
 use: ["tone", "notes"]
 tools: ["get_notes", "save_notes", "get_date"]
 ---
diff --git a/sample/ServiceDefaults.cs b/sample/ServiceDefaults.cs
@@ -1,13 +1,10 @@
 ﻿using Devlooped.Agents.AI;
-using DotNetEnv.Configuration;
 using OpenTelemetry;
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Resources;
 using OpenTelemetry.Trace;
 using Tomlyn.Extensions.Configuration;
 
-
-
 #if WEB
 using Microsoft.Extensions.Diagnostics.HealthChecks;
 using Microsoft.AspNetCore.Diagnostics.HealthChecks;
@@ -25,7 +22,6 @@ public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder)
 
         // .env/secrets override other config, which may contain dummy API keys, for example
         builder.Configuration
-            .AddDotNetEnv()
             .AddEnvironmentVariables()
             .AddUserSecrets<Program>();
 
diff --git a/src/Agents/Agents.csproj b/src/Agents/Agents.csproj
@@ -23,10 +23,10 @@
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="10.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="10.0.0" />
 
-    <PackageReference Include="Microsoft.Agents.AI" Version="42.42.11-pre" />
-    <PackageReference Include="Microsoft.Agents.AI.Hosting" Version="42.42.11-pre" />
-    <PackageReference Include="Microsoft.Agents.AI.AzureAI" Version="42.42.11-pre" />
-    <PackageReference Include="Microsoft.Agents.AI.OpenAI" Version="42.42.11-pre" />
+    <PackageReference Include="Microsoft.Agents.AI" Version="42.42.12-pre" />
+    <PackageReference Include="Microsoft.Agents.AI.Hosting" Version="42.42.12-pre" />
+    <PackageReference Include="Microsoft.Agents.AI.AzureAI" Version="42.42.12-pre" />
+    <PackageReference Include="Microsoft.Agents.AI.OpenAI" Version="42.42.12-pre" />
     <PackageReference Include="ModelContextProtocol" Version="0.4.0-preview.3" />
     <PackageReference Include="PolySharp" Version="1.15.0" PrivateAssets="all" />
     <PackageReference Include="YamlDotNet" Version="16.3.0" />
diff --git a/src/Agents/ConfigurableAIAgent.cs b/src/Agents/ConfigurableAIAgent.cs
@@ -90,20 +90,19 @@ public override IAsyncEnumerable<AgentRunResponseUpdate> RunStreamingAsync(IEnum
         var options = configSection.Get<AgentClientOptions>();
         options?.Name ??= name;
         options?.Description = options?.Description?.Dedent();
-        options?.Instructions = options?.Instructions?.Dedent();
 
         var properties = configSection.Get<AdditionalPropertiesDictionary>();
         if (properties is not null)
         {
-            properties?.Remove(nameof(AgentClientOptions.Name));
-            properties?.Remove(nameof(AgentClientOptions.Description));
-            properties?.Remove(nameof(AgentClientOptions.Instructions));
-            properties?.Remove(nameof(AgentClientOptions.Client));
-            properties?.Remove(nameof(AgentClientOptions.Model));
-            properties?.Remove(nameof(AgentClientOptions.Use));
-            properties?.Remove(nameof(AgentClientOptions.Tools));
-
-            AdditionalProperties = properties;
+            properties.Remove(nameof(AgentClientOptions.Name));
+            properties.Remove(nameof(AgentClientOptions.Description));
+            properties.Remove(nameof(AgentClientOptions.Client));
+            properties.Remove(nameof(AgentClientOptions.Use));
+            properties.Remove(nameof(AgentClientOptions.Tools));
+            properties.Remove(nameof(ChatOptions.ModelId));
+            properties.Remove(nameof(ChatOptions.Instructions));
+
+            AdditionalProperties = properties.Count == 0 ? null : properties;
         }
 
         // If there was a custom id, we must validate it didn't change since that's not supported.
@@ -120,10 +119,10 @@ public override IAsyncEnumerable<AgentRunResponseUpdate> RunStreamingAsync(IEnum
             ? configSection.GetSection("options").Get<GrokChatOptions>()
             : configSection.GetSection("options").Get<ExtendedChatOptions>();
 
+        chat?.Instructions = chat?.Instructions?.Dedent();
+
         if (chat is not null)
             options.ChatOptions = chat;
-        else if (options.Model is not null)
-            (options.ChatOptions ??= new()).ModelId = options.Model;
 
         configure?.Invoke(name, options);
 
@@ -237,7 +236,6 @@ void OnReload(object? state)
     internal class AgentClientOptions : ChatClientAgentOptions
     {
         public string? Client { get; set; }
-        public string? Model { get; set; }
         public IList<string>? Use { get; set; }
         public IList<string>? Tools { get; set; }
     }
diff --git a/src/Agents/ConfigurableAgentsExtensions.cs b/src/Agents/ConfigurableAgentsExtensions.cs
@@ -91,7 +91,6 @@ public static IAIAgentsBuilder AddAIAgents(this IHostApplicationBuilder builder,
             var section = string.Join(':', entry.Key.Split(':')[..^1]);
             // key == name (unlike chat clients, the AddAIAgent expects the key to be the name). 
             var name = builder.Configuration[$"{section}:name"] ?? section[(prefix.Length + 1)..];
-
             var options = builder.Configuration.GetRequiredSection(section).Get<ChatClientAgentOptions>();
             // We need logging set up for the configurable client to log changes
             builder.Services.AddLogging();
diff --git a/src/Tests/ConfigurableAgentTests.cs b/src/Tests/ConfigurableAgentTests.cs
@@ -1,5 +1,4 @@
 ﻿using Devlooped.Extensions.AI;
-using Devlooped.Extensions.AI.Grok;
 using Microsoft.Agents.AI;
 using Microsoft.Extensions.AI;
 using Microsoft.Extensions.Configuration;
@@ -110,7 +109,7 @@ Line 2
                     Line 3
 
                 """,
-            ["ai:agents:bot:instructions"] =
+            ["ai:agents:bot:options:instructions"] =
                 """
                         Agent Instructions:
                             - Step 1
@@ -139,7 +138,7 @@ Line 3
                 - Step 1
                 - Step 2
                 - Step 3
-            """, agent.GetService<ChatClientAgentOptions>()?.Instructions);
+            """, agent.GetService<ChatClientAgentOptions>()?.ChatOptions?.Instructions);
     }
 
     [Fact]
@@ -166,7 +165,7 @@ public void CanReloadConfiguration()
         var agent = app.Services.GetRequiredKeyedService<AIAgent>("bot");
 
         Assert.Equal("Helpful chat agent", agent.Description);
-        Assert.Equal("You are a helpful agent.", agent.GetService<ChatClientAgentOptions>()?.Instructions);
+        Assert.Equal("You are a helpful agent.", agent.GetService<ChatClientAgentOptions>()?.ChatOptions?.Instructions);
         Assert.Equal("openai", agent.GetService<AIAgentMetadata>()?.ProviderName);
 
         // Change the configuration to point to a different client
@@ -179,7 +178,7 @@ public void CanReloadConfiguration()
         configuration.Reload();
 
         Assert.Equal("Very helpful chat agent", agent.Description);
-        Assert.Equal("You are a very helpful chat agent.", agent.GetService<ChatClientAgentOptions>()?.Instructions);
+        Assert.Equal("You are a very helpful chat agent.", agent.GetService<ChatClientAgentOptions>()?.ChatOptions?.Instructions);
         Assert.Equal("xai", agent.GetService<AIAgentMetadata>()?.ProviderName);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`using Devlooped.Agents.AI;`
`2`	`2`	`using Devlooped.Extensions.AI;`
`3`		`-using Microsoft.Agents.AI.Hosting;`
	`3`	`+using Microsoft.Agents.AI;`
`4`	`4`	`using Microsoft.Extensions.AI;`
`5`	`5`	`using Newtonsoft.Json;`
`6`	`6`	`using Newtonsoft.Json.Serialization;`
`@@ -13,7 +13,6 @@ public static class ConsoleExtensions`
`13`	`13`	`{`
`14`	`14`	`public async ValueTask RenderAgentsAsync(IServiceCollection collection)`
`15`	`15`	`{`
`16`		`- var catalog = services.GetRequiredService<AgentCatalog>();`
`17`	`16`	`var settings = new JsonSerializerSettings`
`18`	`17`	`{`
`19`	`18`	`NullValueHandling = NullValueHandling.Include,`
`@@ -38,14 +37,24 @@ public async ValueTask RenderAgentsAsync(IServiceCollection collection)`
`38`	`37`	`}`
`39`	`38`
`40`	`39`	`// List configured agents`
`41`		`- await foreach (var agent in catalog.GetAgentsAsync())`
	`40`	`+ var rendered = new HashSet<string>(StringComparer.OrdinalIgnoreCase);`
	`41`	`+ foreach (var descriptor in collection.AsEnumerable().Where(x => x.ServiceType == typeof(AIAgent) && x.IsKeyedService && x.ServiceKey is string))`
`42`	`42`	`{`
	`43`	`+ if (rendered.Contains((string)descriptor.ServiceKey!))`
	`44`	`+ continue;`
	`45`	`+`
	`46`	`+ var agent = services.GetKeyedService<AIAgent>(descriptor.ServiceKey);`
	`47`	`+ if (agent is null)`
	`48`	`+ continue;`
	`49`	`+`
`43`	`50`	`var metadata = agent.GetService<ConfigurableAIAgentMetadata>();`
`44`	`51`
`45`	`52`	`AnsiConsole.Write(new Panel(new JsonText(JsonConvert.SerializeObject(new { Agent = agent, Metadata = metadata }, settings)))`
`46`	`53`	`{`
`47`	`54`	`Header = new PanelHeader($"\| 🤖 {agent.DisplayName} from {metadata?.ConfigurationSection} \|"),`
`48`	`55`	`});`
	`56`	`+`
	`57`	`+ rendered.Add((string)descriptor.ServiceKey!);`
`49`	`58`	`}`
`50`	`59`	`}`
`51`	`60`	`}`