fix: recommend AIProjectClient instead of PersistentAgentsClient#1209
Merged
XiaofuHuang merged 1 commit intomicrosoft:mainfrom Nov 19, 2025
Merged
Conversation
Contributor
Author
|
/azp run mcp - pullrequest - live |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Azure AI Best Practices documentation to recommend AIProjectClient instead of the legacy PersistentAgentsClient for creating agents in Azure AI Foundry. This aligns with the latest Microsoft Agent Framework release (dotnet-1.0.0-preview.251114.1).
Key changes:
- Updated agent type recommendations from
PersistentAgentsClienttoAIProjectClientacross all documentation files - Added new code examples demonstrating
AIProjectClientusage patterns - Marked
PersistentAgentsClientas legacy with migration guidance - Updated package installation instructions to clarify that
Azure.AI.Projectsis included transitively
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| tools/Azure.Mcp.Tools.AzureAIBestPractices/src/Resources/ai-error-patterns.txt | Replaced PersistentAgentsClient examples with AIProjectClient patterns, including comprehensive code samples for creating agents with tools and structured output |
| tools/Azure.Mcp.Tools.AzureAIBestPractices/src/Resources/ai-best-practices-core.txt | Updated SDK selection guidance and installation instructions to recommend AIProjectClient, changed quickstart reference to GitHub sample |
| tools/Azure.Mcp.Tools.AzureAIBestPractices/src/Resources/ai-background-knowledge.txt | Updated agent types documentation to list AIProjectClient as recommended and PersistentAgentsClient as legacy |
cd97c11 to
ad524ef
Compare
f6596d2 to
e1aae00
Compare
fanyang-mono
approved these changes
Nov 19, 2025
20 tasks
colbytimm
pushed a commit
to colbytimm/microsoft-mcp
that referenced
this pull request
Dec 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
In the latest release of Microsoft Agent Framework, agent hosted in Azure AI Foundry use
AIProjectClientinstead ofPersistentAgentsClient.Detail: https://github.com/microsoft/agent-framework/releases/tag/dotnet-1.0.0-preview.251114.1
Pre-merge Checklist
servers/Azure.Mcp.Server/CHANGELOG.mdand/orservers/Fabric.Mcp.Server/CHANGELOG.mdfor product changes (features, bug fixes, UI/UX, updated dependencies)servers/Azure.Mcp.Server/README.mdand/orservers/Fabric.Mcp.Server/README.mddocumentationeng/scripts/Process-PackageReadMe.ps1. See Package README/servers/Azure.Mcp.Server/docs/azmcp-commands.mdand/or/docs/fabric-commands.md.\eng\scripts\Update-AzCommandsMetadata.ps1to update tool metadata in azmcp-commands.md (required for CI)ToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test promptsconsolidated-tools.json/servers/Azure.Mcp.Server/docs/e2eTestPrompts.mdcrypto mining, spam, data exfiltration, etc.)/azp run mcp - pullrequest - liveto run Live Test Pipeline