dotnet-microsoft-agent-framework

name	dotnet-microsoft-agent-framework
version	1.8.0
category	AI
description	Build .NET AI agents and multi-agent workflows with Microsoft Agent Framework using the right agent type, threads, tools, workflows, hosting protocols, and enterprise guardrails.
compatibility	Requires preview-era Microsoft Agent Framework packages and a .NET application that truly needs agentic or workflow orchestration.

Microsoft Agent Framework

Trigger On

• building or reviewing .NET code that uses Microsoft.Agents.*, Microsoft.Extensions.AI, AIAgent, AgentThread, AgentSession, or Agent Framework hosting packages
• choosing between ChatClientAgent, Responses agents, hosted agents, custom agents, Anthropic agents, workflows, or durable agents
• authoring preview-era Microsoft.Agents.AI.Workflows.Declarative* packages or wrapping a workflow with workflow.AsAIAgent()
• adding tools, MCP, A2A, OpenAI-compatible hosting, AG-UI, DevUI, background responses, or OpenTelemetry
• migrating from Semantic Kernel agent APIs or aligning AutoGen-style multi-agent patterns to Agent Framework
• using Anthropic Claude models (haiku, sonnet, opus) via AnthropicClient or through Azure Foundry with AnthropicFoundryClient

Workflow

1. Decide whether the problem should stay deterministic. If plain code or a typed workflow without LLM autonomy is enough, do that instead of adding an agent.
2. Choose the execution shape first: single AIAgent, explicit programmatic Workflow, workflow-as-agent wrapper, declarative workflow when YAML portability is explicitly required, Azure Functions durable agent, ASP.NET Core hosted agent, AG-UI remote UI, or DevUI local debugging.
3. Choose the agent type and provider intentionally. Prefer the simplest agent that satisfies the threading, tooling, and hosting requirements.
4. Keep agents stateless and keep conversation or long-lived state in provider-owned session objects. Most persistence guidance still centers on AgentThread, while newer middleware and background-response examples may surface AgentSession. Treat both as opaque provider-specific state.
5. Add only the tools and middleware that the scenario needs. Narrow the tool surface, require approval for side effects, and treat MCP, A2A, and third-party services as trust boundaries.
6. For workflows, model executors, edges, request-response ports, checkpoints, shared state, and human-in-the-loop explicitly rather than hiding control flow in prompts.
7. Prefer Responses-based protocols for new remote/OpenAI-compatible integrations unless you specifically need Chat Completions compatibility.
8. Use durable agents only when you truly need Azure Functions serverless hosting, durable thread storage, or deterministic long-running orchestrations.
9. Verify preview status, package maturity, docs recency, and provider-specific limitations before locking a production architecture.

Architecture

flowchart LR
  A["Task"] --> B{"Deterministic code is enough?"}
  B -->|Yes| C["Write normal .NET code or a plain workflow"]
  B -->|No| D{"One dynamic decision-maker is enough?"}
  D -->|Yes| E["Use an `AIAgent` / `ChatClientAgent`"]
  D -->|No| F["Use a typed `Workflow`"]
  F --> G{"Needs durable Azure hosting or week-long execution?"}
  G -->|Yes| H["Use durable agents on Azure Functions"]
  G -->|No| I["Use in-process workflows"]
  E --> J{"Need a remote protocol or UI?"}
  F --> J
  J -->|OpenAI-compatible HTTP| K["ASP.NET Core Hosting.OpenAI"]
  J -->|Agent-to-agent protocol| L["A2A hosting"]
  J -->|Web UI protocol| M["AG-UI"]
  J -->|Local debug shell| N["DevUI (dev only)"]

Core Knowledge

• AIAgent is the common runtime abstraction. It should stay mostly stateless.
• AgentThread still anchors most persisted conversation guidance, but some newer runtime surfaces now pass AgentSession instead. Treat either state object as opaque provider-owned data and verify exact callback signatures against the current official page.
• AgentResponse and AgentResponseUpdate are not just text containers. They can include tool calls, tool results, structured output, reasoning-like updates, and response metadata.
• ChatClientAgent is the safest default when you already have an IChatClient and do not need a hosted-agent service.
• Current Learn docs now treat Microsoft Foundry Agents as the canonical Azure-hosted persistent-agent page. The old Azure AI Foundry Agent and Foundry Models Chat/Responses URLs now collapse into that broader provider surface, so do not model them as separate top-level product families in design discussions.
• Current Learn docs also position Azure OpenAI Responses as the richest Azure OpenAI client: it is the path that exposes tool approval, code interpreter, file search, web search, hosted MCP, and local MCP tools.
• Workflow is an explicit graph of executors and edges. Use it when the control flow must stay inspectable, typed, resumable, or human-steerable.
• workflow.AsAIAgent() is the escape hatch when a complex workflow needs to present a normal agent surface. It keeps sessions, streaming, and agent response APIs, but the workflow start executor still needs chat-message-compatible input.
• AgentWorkflowBuilder provides high-level factory methods such as BuildConcurrent for common agent orchestration patterns. Use it when you need concurrent or sequential agent pipelines without writing custom executor classes.
• Declarative workflows are now a documented surface, but the .NET package/runtime story is still preview-heavy and narrower than programmatic workflows. Use YAML when portability and operator-editable orchestration matter; keep deeply custom .NET control flow programmatic.
• Hosting layers such as OpenAI-compatible HTTP, A2A, and AG-UI are adapters over your in-process agent or workflow. They do not replace the core architecture choice.
• Durable agents are a hosting and persistence decision for Azure Functions. They are not the default answer for ordinary app-level orchestration.
• Current Learn docs now consolidate middleware under agents/middleware and tools under agents/tools/*; older tutorial URLs can redirect to the same canonical page, so prefer the canonical path when exact signatures or headings matter.

Decision Cheatsheet

If you need	Default choice	Why
One model-backed assistant with normal .NET composition	ChatClientAgent or chatClient.AsAIAgent(...)	Lowest friction, middleware-friendly, works with IChatClient
OpenAI-style future-facing APIs, background responses, or richer response state	Responses-based agent	Better fit for new OpenAI-compatible integrations
Simple client-managed chat history	Chat Completions agent	Keeps request/response simple
Service-hosted agents and service-owned threads/tools	Microsoft Foundry Agent or other hosted agent	Managed runtime is the requirement
Azure-hosted OpenAI-compatible models with the richest hosted-tool surface but app-owned composition	Azure OpenAI Responses agent	Best Azure OpenAI default when you need code interpreter, file search, web search, hosted MCP, or tool approval without moving to a persistent service-managed agent
Anthropic Claude models (haiku, sonnet, opus) directly or via Azure Foundry	AnthropicClient.AsAIAgent(...) or AnthropicFoundryClient.AsAIAgent(...)	Use Microsoft.Agents.AI.Anthropic; add Anthropic.Foundry for Azure-hosted Claude
Typed multi-step orchestration	Workflow or AgentWorkflowBuilder helpers	Control flow stays explicit and testable; use BuildConcurrent for agent fan-out/fan-in
YAML-defined orchestration that non-developers or operators need to edit	Declarative workflow packages	Good for portable trigger/action graphs; do not pretend the .NET preview is as flexible as programmatic workflows
Week-long or failure-resilient Azure execution	Durable agent on Azure Functions	Durable Task gives replay and persisted state
Agent-to-agent interoperability	A2A hosting or A2A proxy agent	This is protocol-level delegation, not local inference
Browser or web UI protocol integration	AG-UI	Designed for remote UI sync and approval flows

Common Failure Modes

• Adding an agent where deterministic code or a plain typed workflow would be clearer and cheaper.
• Assuming agent instance fields are the durable source of truth instead of storing real state in AgentThread, stores, or workflow state.
• Picking Chat Completions when the scenario really needs Responses features such as background execution or service-backed response chains.
• Treating hosted-agent services and local IChatClient agents as if they share the same thread and tool guarantees.
• Hiding orchestration inside prompts instead of modeling executors, edges, requests, checkpoints, and HITL explicitly.
• Exposing too many tools at once, especially side-effecting tools without approvals, middleware checks, or clear trust boundaries.
• Treating DevUI as a production UI surface instead of a development and debugging tool.

Deliver

• a justified architecture choice: agent vs workflow vs durable orchestration
• the concrete .NET agent type, provider, and package set
• an explicit thread, tool, middleware, and observability strategy
• hosting and protocol decisions for OpenAI-compatible APIs, A2A, AG-UI, or Azure Functions
• migration notes when replacing Semantic Kernel agent APIs or AutoGen-style orchestration

Validate

• the scenario really needs agentic behavior and is not better served by deterministic code
• the selected agent type matches the provider, thread model, and tool model
• AgentThread or AgentSession lifecycle, serialization, and compatibility boundaries are explicit for the chosen provider surface
• tool approval, MCP headers, and third-party trust boundaries are handled safely
• workflows define checkpoints, request-response, shared state, and HITL paths deliberately
• DevUI is treated as a development sample, not a production surface
• docs or packages marked preview are called out, and Python-only docs are not mistaken for guaranteed .NET APIs

When a decision depends on exact wording, long-tail feature coverage, or a less-common integration, check the local official docs snapshot before relying on summaries.

References

• official-docs-index.md - Slim local Microsoft Learn snapshot map with direct links to every mirrored page, live-only support pages, and API-reference pointers
• patterns.md - Architecture routing, agent types, provider and thread model selection, and durable-agent guidance
• providers.md - Provider, SDK, endpoint, package, and Responses-vs-ChatCompletions selection
• tools.md - Function tools, hosted tools, tool approval, agent-as-tool, and service limitations
• sessions.md - AgentThread, chat history storage, reducers, context providers, and thread serialization
• middleware.md - Agent, function-calling, and IChatClient middleware with guardrail patterns
• workflows.md - Executors, edges, requests and responses, checkpoints, orchestrations, and declarative workflow notes
• mcp.md - MCP integration, agent-as-MCP, security rules, and MCP-vs-A2A guidance
• hosting.md - ASP.NET Core hosting, OpenAI-compatible APIs, A2A, AG-UI, Azure Functions, and Purview integration
• devui.md - DevUI capabilities, modes, auth, tracing, and safe usage boundaries
• migration.md - Semantic Kernel and AutoGen migration notes, concept mapping, and breaking-model shifts
• support.md - Preview status, official support channels, and recurring troubleshooting checks
• examples.md - Quick-start and tutorial recipe index covering the official docs set