.NET: Improve AIAgent and Workflow registrations for DevUI integration

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/ActorFrameworkWebApplicationExtensions.cs

@@ -2,32 +2,32 @@
 
 using System.Diagnostics.CodeAnalysis;
 using System.Text.Json.Serialization;
-using Microsoft.Agents.AI.Hosting;
+using Microsoft.Agents.AI;
 
 namespace AgentWebChat.AgentHost;
 
 internal static class ActorFrameworkWebApplicationExtensions
 {
     public static void MapAgentDiscovery(this IEndpointRouteBuilder endpoints, [StringSyntax("Route")] string path)
     {
+        var registeredAIAgents = endpoints.ServiceProvider.GetKeyedServices<AIAgent>(KeyedService.AnyKey);
+
         var routeGroup = endpoints.MapGroup(path);
-        routeGroup.MapGet("/", async (
-            AgentCatalog agentCatalog,
-            CancellationToken cancellationToken) =>
+        routeGroup.MapGet("/", async (CancellationToken cancellationToken) =>
+        {
+            var results = new List<AgentDiscoveryCard>();
+            foreach (var result in registeredAIAgents)
             {
-                var results = new List<AgentDiscoveryCard>();
-                await foreach (var result in agentCatalog.GetAgentsAsync(cancellationToken).ConfigureAwait(false))
+                results.Add(new AgentDiscoveryCard
                 {
-                    results.Add(new AgentDiscoveryCard
-                    {
-                        Name = result.Name!,
-                        Description = result.Description,
-                    });
-                }
+                    Name = result.Name!,
+                    Description = result.Description,
+                });
+            }
 
-                return Results.Ok(results);
-            })
-            .WithName("GetAgents");
+            return Results.Ok(results);
+        })
+        .WithName("GetAgents");
     }
 
     internal sealed class AgentDiscoveryCard

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/AgentWebChat.AgentHost.csproj

@@ -8,6 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.DevUI\Microsoft.Agents.AI.DevUI.csproj" />
     <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Workflows\Microsoft.Agents.AI.Workflows.csproj" />
     <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Abstractions\Microsoft.Agents.AI.Abstractions.csproj" />
     <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Hosting\Microsoft.Agents.AI.Hosting.csproj" />

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Program.cs

@@ -5,6 +5,7 @@
 using AgentWebChat.AgentHost.Custom;
 using AgentWebChat.AgentHost.Utilities;
 using Microsoft.Agents.AI;
+using Microsoft.Agents.AI.DevUI;
 using Microsoft.Agents.AI.Hosting;
 using Microsoft.Agents.AI.Workflows;
 using Microsoft.Extensions.AI;
@@ -21,6 +22,13 @@
 // Configure the chat model and our agent.
 builder.AddKeyedChatClient("chat-model");
 
+// Add DevUI services
+builder.AddDevUI();
+
+// Add OpenAI services
+builder.AddOpenAIChatCompletions();
+builder.AddOpenAIResponses();
+
 var pirateAgentBuilder = builder.AddAIAgent(
     "pirate",
     instructions: "You are a pirate. Speak like a pirate",
@@ -95,8 +103,42 @@ Once the user has deduced what type (knight or knave) both Alice and Bob are, te
     return AgentWorkflowBuilder.BuildConcurrent(workflowName: key, agents: agents);
 }).AddAsAIAgent();
 
-builder.AddOpenAIChatCompletions();
-builder.AddOpenAIResponses();
+builder.AddWorkflow("nonAgentWorkflow", (sp, key) =>
+{
+    List<IHostedAgentBuilder> usedAgents = [pirateAgentBuilder, chemistryAgent];
+    var agents = usedAgents.Select(ab => sp.GetRequiredKeyedService<AIAgent>(ab.Name));
+    return AgentWorkflowBuilder.BuildSequential(workflowName: key, agents: agents);
+});
+
+builder.Services.AddKeyedSingleton("NonAgentAndNonmatchingDINameWorkflow", (sp, key) =>
+{
+    List<IHostedAgentBuilder> usedAgents = [pirateAgentBuilder, chemistryAgent];
+    var agents = usedAgents.Select(ab => sp.GetRequiredKeyedService<AIAgent>(ab.Name));
+    return AgentWorkflowBuilder.BuildSequential(workflowName: "random-name", agents: agents);
+});
+
+builder.Services.AddKeyedSingleton<AIAgent>("my-di-nonmatching-agent", (sp, name) =>
+{
+    var chatClient = sp.GetRequiredKeyedService<IChatClient>("chat-model");
+    return new ChatClientAgent(
+        chatClient,
+        name: "some-random-name", // demonstrating registration can be different for DI and actual agent
+        instructions: "you are a dependency inject agent. Tell me all about dependency injection.");
+});
+
+builder.Services.AddKeyedSingleton<AIAgent>("my-di-matchingname-agent", (sp, name) =>
+{
+    if (name is not string nameStr)
+    {
+        throw new NotSupportedException("Name should be passed as a key");
+    }
+
+    var chatClient = sp.GetRequiredKeyedService<IChatClient>("chat-model");
+    return new ChatClientAgent(
+        chatClient,
+        name: nameStr, // demonstrating registration with the same name
+        instructions: "you are a dependency inject agent. Tell me all about dependency injection.");
+});
 
 var app = builder.Build();
 
@@ -118,7 +160,10 @@ Once the user has deduced what type (knight or knave) both Alice and Bob are, te
     // Url = "http://localhost:5390/a2a/knights-and-knaves"
 });
 
+app.MapDevUI();
+
 app.MapOpenAIResponses();
+app.MapOpenAIConversations();
 
 app.MapOpenAIChatCompletions(pirateAgentBuilder);
 app.MapOpenAIChatCompletions(knightsKnavesAgentBuilder);

dotnet/samples/AgentWebChat/AgentWebChat.AppHost/Program.cs

@@ -9,7 +9,9 @@
 var chatModel = builder.AddAIModel("chat-model").AsAzureOpenAI("gpt-4o", o => o.AsExisting(azOpenAiResource, azOpenAiResourceGroup));
 
 var agentHost = builder.AddProject<Projects.AgentWebChat_AgentHost>("agenthost")
-        .WithReference(chatModel);
+    .WithHttpEndpoint(name: "devui")
+    .WithUrlForEndpoint("devui", (url) => new() { Url = "/devui", DisplayText = "Dev UI" })
+    .WithReference(chatModel);
 
 builder.AddProject<Projects.AgentWebChat_Web>("webfrontend")
     .WithExternalHttpEndpoints()

dotnet/src/Microsoft.Agents.AI.DevUI/EntitiesApiExtensions.cs

@@ -1,10 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
-using System.Runtime.CompilerServices;
 using System.Text.Json;
-
 using Microsoft.Agents.AI.DevUI.Entities;
-using Microsoft.Agents.AI.Hosting;
 using Microsoft.Agents.AI.Workflows;
 using Microsoft.Extensions.AI;
 
@@ -27,21 +24,26 @@ internal static class EntitiesApiExtensions
     /// <item><description>GET /v1/entities/{entityId}/info - Get detailed information about a specific entity</description></item>
     /// </list>
     /// The endpoints are compatible with the Python DevUI frontend and automatically discover entities
-    /// from the registered <see cref="AgentCatalog"/> and <see cref="WorkflowCatalog"/> services.
+    /// from the registered <see cref="AIAgent">agents</see> and <see cref="Workflow">workflows</see> in the dependency injection container.
     /// </remarks>
     public static IEndpointConventionBuilder MapEntities(this IEndpointRouteBuilder endpoints)
     {
+        var registeredAIAgents = endpoints.ServiceProvider.GetKeyedServices<AIAgent>(KeyedService.AnyKey);
+        var registeredWorkflows = endpoints.ServiceProvider.GetKeyedServices<Workflow>(KeyedService.AnyKey);
+
         var group = endpoints.MapGroup("/v1/entities")
             .WithTags("Entities");
 
         // List all entities
-        group.MapGet("", ListEntitiesAsync)
+        group.MapGet("", (CancellationToken cancellationToken)
+                => ListEntitiesAsync(registeredAIAgents, registeredWorkflows, cancellationToken))
             .WithName("ListEntities")
             .WithSummary("List all registered entities (agents and workflows)")
             .Produces<DiscoveryResponse>(StatusCodes.Status200OK, contentType: "application/json");
 
         // Get detailed entity information
-        group.MapGet("{entityId}/info", GetEntityInfoAsync)
+        group.MapGet("{entityId}/info", (string entityId, string? type, CancellationToken cancellationToken)
+                => GetEntityInfoAsync(entityId, type, registeredAIAgents, registeredWorkflows, cancellationToken))
             .WithName("GetEntityInfo")
             .WithSummary("Get detailed information about a specific entity")
             .Produces<EntityInfo>(StatusCodes.Status200OK, contentType: "application/json")
@@ -51,22 +53,22 @@ public static IEndpointConventionBuilder MapEntities(this IEndpointRouteBuilder
     }
 
     private static async Task<IResult> ListEntitiesAsync(
-        AgentCatalog? agentCatalog,
-        WorkflowCatalog? workflowCatalog,
+        IEnumerable<AIAgent> agents,
+        IEnumerable<Workflow> workflows,
         CancellationToken cancellationToken)
     {
         try
         {
             var entities = new Dictionary<string, EntityInfo>();
 
             // Discover agents
-            await foreach (var agentInfo in DiscoverAgentsAsync(agentCatalog, entityIdFilter: null, cancellationToken).ConfigureAwait(false))
+            foreach (var agentInfo in DiscoverAgents(agents, entityIdFilter: null))
             {
                 entities[agentInfo.Id] = agentInfo;
             }
 
             // Discover workflows
-            await foreach (var workflowInfo in DiscoverWorkflowsAsync(workflowCatalog, entityIdFilter: null, cancellationToken).ConfigureAwait(false))
+            foreach (var workflowInfo in DiscoverWorkflows(workflows, entityIdFilter: null))
             {
                 entities[workflowInfo.Id] = workflowInfo;
             }
@@ -85,23 +87,23 @@ private static async Task<IResult> ListEntitiesAsync(
     private static async Task<IResult> GetEntityInfoAsync(
         string entityId,
         string? type,
-        AgentCatalog? agentCatalog,
-        WorkflowCatalog? workflowCatalog,
+        IEnumerable<AIAgent> agents,
+        IEnumerable<Workflow> workflows,
         CancellationToken cancellationToken)
     {
         try
         {
             if (type is null || string.Equals(type, "workflow", StringComparison.OrdinalIgnoreCase))
             {
-                await foreach (var workflowInfo in DiscoverWorkflowsAsync(workflowCatalog, entityId, cancellationToken).ConfigureAwait(false))
+                foreach (var workflowInfo in DiscoverWorkflows(workflows, entityId))
                 {
                     return Results.Json(workflowInfo, EntitiesJsonContext.Default.EntityInfo);
                 }
             }
 
             if (type is null || string.Equals(type, "agent", StringComparison.OrdinalIgnoreCase))
             {
-                await foreach (var agentInfo in DiscoverAgentsAsync(agentCatalog, entityId, cancellationToken).ConfigureAwait(false))
+                foreach (var agentInfo in DiscoverAgents(agents, entityId))
                 {
                     return Results.Json(agentInfo, EntitiesJsonContext.Default.EntityInfo);
                 }
@@ -118,17 +120,9 @@ private static async Task<IResult> GetEntityInfoAsync(
         }
     }
 
-    private static async IAsyncEnumerable<EntityInfo> DiscoverAgentsAsync(
-        AgentCatalog? agentCatalog,
-        string? entityIdFilter,
-        [EnumeratorCancellation] CancellationToken cancellationToken)
+    private static IEnumerable<EntityInfo> DiscoverAgents(IEnumerable<AIAgent> agents, string? entityIdFilter)
     {
-        if (agentCatalog is null)
-        {
-            yield break;
-        }
-
-        await foreach (var agent in agentCatalog.GetAgentsAsync(cancellationToken).ConfigureAwait(false))
+        foreach (var agent in agents)
         {
             // If filtering by entity ID, skip non-matching agents
             if (entityIdFilter is not null &&
@@ -148,17 +142,9 @@ private static async IAsyncEnumerable<EntityInfo> DiscoverAgentsAsync(
         }
     }
 
-    private static async IAsyncEnumerable<EntityInfo> DiscoverWorkflowsAsync(
-        WorkflowCatalog? workflowCatalog,
-        string? entityIdFilter,
-        [EnumeratorCancellation] CancellationToken cancellationToken)
+    private static IEnumerable<EntityInfo> DiscoverWorkflows(IEnumerable<Workflow> workflows, string? entityIdFilter)
     {
-        if (workflowCatalog is null)
-        {
-            yield break;
-        }
-
-        await foreach (var workflow in workflowCatalog.GetWorkflowsAsync(cancellationToken).ConfigureAwait(false))
+        foreach (var workflow in workflows)
         {
             var workflowId = workflow.Name ?? workflow.StartExecutorId;
 

dotnet/src/Microsoft.Agents.AI.DevUI/HostApplicationBuilderExtensions.cs

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+namespace Microsoft.Extensions.Hosting;
+
+/// <summary>
+/// Extension methods for <see cref="IHostApplicationBuilder"/> to configure DevUI.
+/// </summary>
+public static class MicrosoftAgentAIDevUIHostApplicationBuilderExtensions
+{
+    /// <summary>
+    /// Adds DevUI services to the host application builder.
+    /// </summary>
+    /// <param name="builder">The <see cref="IHostApplicationBuilder"/> to configure.</param>
+    /// <returns>The <see cref="IHostApplicationBuilder"/> for method chaining.</returns>
+    public static IHostApplicationBuilder AddDevUI(this IHostApplicationBuilder builder)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+        builder.Services.AddDevUI();
+
+        return builder;
+    }
+}

dotnet/src/Microsoft.Agents.AI.DevUI/Microsoft.Agents.AI.DevUI.csproj

@@ -12,6 +12,10 @@
     <NoWarn>$(NoWarn);CS1591;CA1852;CA1050;RCS1037;RCS1036;RCS1124;RCS1021;RCS1146;RCS1211;CA2007;CA1308;IL2026;IL3050;CA1812</NoWarn>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <InjectSharedThrow>true</InjectSharedThrow>
+  </PropertyGroup>
+
   <!-- Import nuget packaging properties -->
   <Import Project="$(RepoRoot)/dotnet/nuget/nuget-package.props" />
 

dotnet/src/Microsoft.Agents.AI.DevUI/README.md

@@ -24,9 +24,15 @@ var builder = WebApplication.CreateBuilder(args);
 // Register your agents
 builder.AddAIAgent("assistant", "You are a helpful assistant.");
 
+// Register DevIU services
+if (builder.Environment.IsDevelopment())
+{
+    builder.AddDevUI();
+}
+
 // Register services for OpenAI responses and conversations (also required for DevUI)
-builder.Services.AddOpenAIResponses();
-builder.Services.AddOpenAIConversations();
+builder.AddOpenAIResponses();
+builder.AddOpenAIConversations();
 
 var app = builder.Build();
 

dotnet/src/Microsoft.Agents.AI.DevUI/ServiceCollectionsExtensions.cs

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Agents.AI;
+using Microsoft.Agents.AI.Workflows;
+using Microsoft.Shared.Diagnostics;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+/// <summary>
+/// Extension methods for <see cref="IServiceCollection"/> to configure DevUI.
+/// </summary>
+public static class MicrosoftAgentAIDevUIServiceCollectionsExtensions
+{
+    /// <summary>
+    /// Adds services required for DevUI integration.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to configure.</param>
+    /// <returns>The <see cref="IServiceCollection"/> for method chaining.</returns>
+    public static void AddDevUI(this IServiceCollection services)
+    {
+        // a factory, that tries to construct an AIAgent from Workflow,
+        // even if workflow was not explicitly registered as an AIAgent.
+        services.AddKeyedSingleton(KeyedService.AnyKey, (sp, key) =>
+        {
+            var keyAsStr = key as string;
+            Throw.IfNullOrEmpty(keyAsStr);
+
+            var workflow = sp.GetKeyedService<Workflow>(keyAsStr);
+            if (workflow is null)
+            {
+                throw new InvalidOperationException($"Can't find registered {nameof(AIAgent)} or {nameof(Workflow)} with name '{keyAsStr}'");
+            }
+
+            return workflow.AsAgent(name: workflow.Name);
+        });
+    }
+}

dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/HostedAgentResponseExecutor.cs

@@ -63,7 +63,11 @@ public HostedAgentResponseExecutor(
             return ValueTask.FromResult<ResponseError?>(new ResponseError
             {
                 Code = "agent_not_found",
-                Message = $"Agent '{agentName}' not found. Ensure the agent is registered with AddAIAgent()."
+                Message = $"""
+                    Agent '{agentName}' not found.
+                    Ensure the agent is registered with '{agentName}' name in the dependency injection container.
+                    We recommend using `builder.AddAIAgent()` for simplicity.
+                """
             });
         }