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…

14.2K ·GitHub
Agent-framework
Что это такое?Microsoft Agent Framework (MAF) — это открытый фреймворк с поддержкой нескольких языков для создания, оркестрации и развертывания готовых к промышленной эксплуатации ИИ-агентов и многоагентных рабочих процессов. Полностью поддерживаются Python и .NET, также есть отдельный SDK для Go.
Это фреймворк, с которым я пишу код, или готовое приложение с агентом?Это фреймворк и SDK, на основе которых вы строите своё решение: вы пишете код на Python или C#/.NET, используя единые API для описания агентов и рабочих процессов на основе графов. Готового самостоятельного приложения это не является.
Как начать создавать агента с его помощью?Установите пакет для Python или пакет для .NET, затем следуйте быстрому старту, чтобы создать простого агента, например базового агента Azure Responses Agent, который пишет хайку.
Нужна ли мне учетная запись Azure или API-ключи, чтобы им пользоваться?Нужны учетные данные того поставщика моделей, к которому вы подключаетесь. Например, для учетных данных Azure потребуется вход через Azure CLI, а для остальных поставщиков — действующий API-ключ к ресурсу или сервису, к которому вы обращаетесь.
В чем подвох, если подключить его к сторонним моделям или серверам?Microsoft прямо указывает, что это на ваш риск: сторонние серверы, агенты, код и модели не из Azure регулируются собственными лицензионными условиями, а проверку обработки данных и соответствия требованиям вы должны выполнить самостоятельно.
Какие схемы оркестрации можно построить с его помощью?Многоагентные рабочие процессы на основе графов с поддержкой последовательной и параллельной работы, передачи задачи от одного агента другому и группового взаимодействия. Также есть сохранение контрольных точек, потоковая передача данных, участие человека в процессе и возможность вернуться к предыдущим состояниям.
Можно ли описывать агентов без большого объема кода?Да, можно описывать декларативных агентов с помощью YAML. Это быстрее в настройке и удобнее в управлении версиями, чем писать всё вручную.
Есть ли путь миграции с Semantic Kernel или AutoGen?Да, в проекте есть отдельные руководства по переносу существующих проектов Semantic Kernel и AutoGen на Agent Framework.
Есть ли версия этого фреймворка для Go?Да, отдельный SDK для Go имеет собственную документацию, примеры и трекер задач. Он находится в репозитории microsoft/agent-framework-go.
What are similar projects?hive, harness-sdk, adk-python, PocketFlow, open-multi-agent, semantic-kernel, agentscope, harmonist
Which topics is it in?workflows, human-in-the-loop, azure, github-copilot, yaml, microsoft, agent-framework, dotnet, enterprise, csharp, orchestration, observability
Creator
microsoft
Size
142.3 MB
Stars
14.2K
Updated
CommitOct 16Releasepython-1.22.0Oct 15
Age
1y
Commits · 90 Days