agent-framework README

The project's README from github.com/microsoft/agent-framework. As one markdown file: README.md.

Microsoft Agent Framework

Welcome to Microsoft Agent Framework!

Microsoft Foundry Discord MS Learn Documentation PyPI NuGet GitHub stars

Microsoft Agent Framework (MAF) is an open, multi-language framework for building production-grade AI agents and multi-agent workflows in .NET and Python.

Microsoft Agent Framework is built for teams taking agents from prototype to production. It provides a consistent foundation for building, orchestrating, and operating agent systems across Python, .NET and Go, while keeping architecture choices open as requirements evolve, and supports a broad ecosystem including Microsoft Foundry, Azure OpenAI, OpenAI, and the GitHub Copilot SDK, with samples and hosting patterns for both local development and cloud deployment.

[!NOTE] For the Go SDK, including its documentation, samples, contribution guidance, and issue tracker, visit microsoft/agent-framework-go.

Watch the full Agent Framework introduction (30 min)

Watch the full Agent Framework introduction (30 min)

Is this the right framework for you?

MAF is a strong fit if you:

Key Features

Explore new MAF capabilities and real implementation patterns on the official blog.

Table of Contents

Getting Started

Installation

Python

pip install agent-framework
# This installs the standard package set; install `agent-framework-lab` separately for experimental modules.
# It may take a minute on first install on Windows.

.NET

dotnet add package Microsoft.Agents.AI
# For Foundry integration (used in the .NET quickstart below):
dotnet add package Microsoft.Agents.AI.Foundry
dotnet add package Azure.AI.Projects
dotnet add package Azure.Identity

Learning Resources

Quickstart

Basic Agent - Python

Create a simple Azure Responses Agent that writes a haiku about the Microsoft Agent Framework

# pip install agent-framework
# Use `az login` to authenticate with Azure CLI
import os
import asyncio
from agent_framework import Agent
from agent_framework.foundry import FoundryChatClient
from azure.identity import AzureCliCredential


async def main():
    # Initialize a chat agent with Microsoft Foundry
    # the endpoint, deployment name, and api version can be set via environment variables
    # or they can be passed in directly to the FoundryChatClient constructor
    agent = Agent(
      client=FoundryChatClient(
          credential=AzureCliCredential(),
          # project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
          # model=os.environ["FOUNDRY_MODEL_DEPLOYMENT_NAME"],
      ),
      name="HaikuAgent",
      instructions="You are an upbeat assistant that writes beautifully.",
    )

    print(await agent.run("Write a haiku about Microsoft Agent Framework."))

if __name__ == "__main__":
    asyncio.run(main())

Basic Agent - .NET

Create a simple Agent, using Microsoft Foundry that writes a haiku about the Microsoft Agent Framework

// This sample shows how to create and run a basic agent with AIProjectClient.AsAIAgent(...).

using Azure.AI.Projects;
using Azure.Identity;
using Microsoft.Agents.AI;

string endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
string deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-5.4-mini";

AIAgent agent =
    new AIProjectClient(new Uri(endpoint), new DefaultAzureCredential())
    .AsAIAgent(model: deploymentName, instructions: "You are an upbeat assistant that writes beautifully.", name: "HaikuAgent");

// Once you have the agent, you can invoke it like any other AIAgent.
Console.WriteLine(await agent.RunAsync("Write a haiku about Microsoft Agent Framework."));

More Examples & Samples

Python

.NET

Community & Feedback

Troubleshooting

Authentication

Problem Cause Fix
Authentication errors when using Azure credentials Not signed in to Azure CLI Run az login before starting your app
API key errors Wrong or missing API key Verify the key and ensure it's for the correct resource/provider

Tip: DefaultAzureCredential is convenient for development but in production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid latency issues, unintended credential probing, and potential security risks from fallback mechanisms.

Environment Variables

For environment variable configuration specific to each sample, refer to the README in the sample directory (Python samples | .NET samples).

Contributor Resources

Important Notes

[!IMPORTANT] If you use Microsoft Agent Framework to build applications that operate with any third-party servers, agents, code, or non-Azure Direct models (“Third-Party Systems”), you do so at your own risk. Third-Party Systems are Non-Microsoft Products under the Microsoft Product Terms and are governed by their own third-party license terms. You are responsible for any usage and associated costs.

We recommend reviewing all data being shared with and received from Third-Party Systems and being cognizant of third-party practices for handling, sharing, retention and location of data. It is your responsibility to manage whether your data will flow outside of your organization’s Azure compliance and geographic boundaries and any related implications, and that appropriate permissions, boundaries and approvals are provisioned.

You are responsible for carefully reviewing and testing applications you build using Microsoft Agent Framework in the context of your specific use cases, and making all appropriate decisions and customizations. This includes implementing your own responsible AI mitigations such as metaprompt, content filters, or other safety systems, and ensuring your applications meet appropriate quality, reliability, security, and trustworthiness standards. See also: Transparency FAQ

agent-framework (microsoft/agent-framework)

Searching Database…

这是什么?Microsoft Agent Framework(MAF)是一个开放的多语言框架,用于构建、编排和部署可用于生产环境的 AI 智能体及多智能体工作流,完整支持 Python 和 .NET,另外还提供单独的 Go SDK。
这是我要基于它编写代码的框架,还是现成的智能体应用?它是一个你可以在其上开发的框架和 SDK。你使用 Python 或 C#/.NET 代码,通过统一的 API 定义智能体和基于图的工作流,它本身并不是独立的应用。
我该如何开始用它构建智能体?安装 Python 包或 .NET 包,然后按照 Quickstart 教程构建一个基础智能体,例如一个能写俳句的简单 Azure Responses Agent。
使用它需要 Azure 账户或 API 密钥吗?你需要为所连接的模型提供商准备凭据。例如,使用 Azure 凭据时需要通过 Azure CLI 登录;对于所调用的资源或提供商,需要提供有效的 API 密钥。
如果我把它连接到第三方模型或服务器,有什么需要注意的?微软明确表示,这需要你自行承担风险:第三方服务器、智能体、代码或非 Azure 模型均受其各自许可条款约束,你需要自行审查数据处理和合规性。
我可以用它构建哪些编排模式?可以构建基于图的多智能体工作流,支持顺序、并发、交接和群组协作等模式,并提供检查点、流式传输、人工介入和时间回溯功能。
我可以不写大量代码来定义智能体吗?可以。你可以使用 YAML 以声明式的方式定义智能体,设置更快,版本管理也更方便,无需手动编写全部代码。
有没有从 Semantic Kernel 或 AutoGen 迁移的路径?有。项目提供了专门的指南,帮助你将现有的 Semantic Kernel 或 AutoGen 项目迁移到 Agent Framework。
这个框架有 Go 版本吗?有。单独的 Go SDK 拥有自己的文档、示例和问题跟踪,位于 microsoft/agent-framework-go 代码仓库中。
Creator
microsoft
Size
142.4 MB
Stars
14.2K
Age
1y
Commits · 90 Days