[azure-ai-agents] Fix env var name mismatch, stale link, and grammar in README - #49002
Open
SIDDARTHA REDDY (SIDDARTHAREDDY8) wants to merge 1 commit into
Conversation
|
Azure Pipelines: Successfully started running 1 pipeline(s). 7 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
github-actions
Bot
added
AI Agents
Community Contribution
Contributor
|
Thank you for your contribution SIDDARTHA REDDY (@SIDDARTHAREDDY8)! We will review the pull request and get back to you soon. |
Copilot started reviewing on behalf of
SIDDARTHA REDDY (SIDDARTHAREDDY8)
September 14, 2026 18:44
View session
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation corrections are accurate; only a non-blocking capitalization issue remains.
Pull request overview
Updates the azure-ai-agents README to reduce setup and usage confusion.
Changes:
- Aligns the endpoint environment variable with samples.
- Updates the Azure AI Foundry project link.
- Corrects grammar in role and asynchronous-client guidance.
File summaries
| File | Description |
|---|---|
sdk/ai/azure-ai-agents/README.md |
Corrects setup documentation, link, and wording. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
| - The project endpoint string. It can be found in your Azure AI Foundry project overview page, under "Project details". Below we will assume the environment variable `PROJECT_ENDPOINT` was defined to hold this value. | ||
| - Entra ID is needed to authenticate the client. Your application needs an object that implements the [TokenCredential](https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential) interface. Code samples here use [DefaultAzureCredential](https://learn.microsoft.com/python/api/azure-identity/azure.identity.defaultazurecredential). To get that working, you will need: | ||
| * An appropriate role assignment. see [Role-based access control in Azure AI Foundry portal](https://learn.microsoft.com/azure/ai-foundry/concepts/rbac-ai-foundry). Role assigned can be done via the "Access Control (IAM)" tab of your Azure AI Project resource in the Azure portal. | ||
| * An appropriate role assignment. see [Role-based access control in Azure AI Foundry portal](https://learn.microsoft.com/azure/ai-foundry/concepts/rbac-ai-foundry). Role assignment can be done via the "Access Control (IAM)" tab of your Azure AI Project resource in the Azure portal. |
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.
Description
Fixes #48118. Docs-only fix for four small defects in the
azure-ai-agentsREADME that cause copy-paste friction:PROJECT_ENDPOINT_STRING, but every code snippet and sample readsPROJECT_ENDPOINT(os.environ["PROJECT_ENDPOINT"]), so following the prose leads to aKeyError. Corrected the prose toPROJECT_ENDPOINT.azure/ai-studio/path to the currentazure/ai-foundry/path.AsyncFunctionToolbe discussed in the later sections" -> "Also note that if you use the asynchronous client ...AsyncFunctionToolwill be discussed in later sections".Docs-only; no code or behavior changes.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines
os.environ["PROJECT_ENDPOINT"]usage)