Skip to content

[azure-ai-agents] Fix env var name mismatch, typos, and stale link in README#48118

Open
kkchandi wants to merge 2 commits into
Azure:mainfrom
kkchandi:docs-ai-agents-readme-fixes
Open

[azure-ai-agents] Fix env var name mismatch, typos, and stale link in README#48118
kkchandi wants to merge 2 commits into
Azure:mainfrom
kkchandi:docs-ai-agents-readme-fixes

Conversation

@kkchandi

Copy link
Copy Markdown

This PR fixes several small documentation defects in the azure-ai-agents README that cause copy-paste friction:

  • Env var mismatch: the Prerequisites prose says to define PROJECT_ENDPOINT_STRING, but every code snippet and sample reads PROJECT_ENDPOINT (os.environ["PROJECT_ENDPOINT"]), so following the prose leads to a KeyError. Corrected the prose to PROJECT_ENDPOINT.
  • Stale docs link: updated the "create a project" link from the legacy azure/ai-studio/ path to the current azure/ai-foundry/ path.
  • Grammar: "Role assigned can be done" -> "Role assignment can be done"; "Also notices that if you use asynchronous client ... AsyncFunctionTool be discussed in the later sections" -> "Also note that if you use the asynchronous client ... AsyncFunctionTool will be discussed in later sections".

Docs-only; no code or behavior changes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Copilot AI review requested due to automatic review settings July 17, 2026 20:49
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
9 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates azure-ai-agents documentation to reduce copy-paste errors and improve clarity.

Changes:

  • Aligns the endpoint environment variable with samples.
  • Refreshes the project-creation link.
  • Corrects README grammar.

Comment thread sdk/ai/azure-ai-agents/README.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 17, 2026 20:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants