Python: Minor updates to response-stream example and Foundry hosted agent doc by dargilco · Pull Request #8985 · microsoft/agent-framework

Darren Cohen (dargilco) · 2026-10-02T18:14:59Z

Update all "a Agent" to "an Agent"
Minor update to python\samples\02-agents\response_stream.py
- Update comment at the top to move the Python code below the pattern title, just like done in the above two patterns.
- In example 4, show that the cleanup hook was called after streaming is done, by printing streaming updates. If we don't print the updates, there is no way to see when it was done.
Minor edits to \python\samples\04-hosting\foundry-hosted-agents\README.md to get a sample to run following exact instructions

Contribution Checklist

The code builds clean without any errors or warnings
All unit tests pass, and I have added new tests where possible
The PR follows the Contribution Guidelines
This PR is linked to an issue and there is no other open PR for this issue (see Related Issue above).
This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

Copilot

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

Review effort: Lite
Findings: 3

Open (3)

The explanatory paragraph/bullets for “Pattern 3” now come after the fenced code block. If this… · New
The PR title/description suggest a minor fix limited to response_stream.py, but this PR changes… · New
The added bullet line appears to have lost its indentation compared to the prior value ( |- ...).… · New

What changed in this PR

This PR primarily corrects grammar in Python samples/docstrings (notably “a Agent” → “an Agent”) and adjusts the markdown flow in the response_stream.py sample.

Changes:

Fixes article/grammar issues across samples, packages, and tests (“a agent/Agent” → “an agent/Agent”).
Reorders/rewraps the “Pattern 3: Combined Usage” explanation in response_stream.py.
Minor docstring wording cleanup in multiple modules.

File	Description
python/samples/03-workflows/agents/group_chat_workflow_as_agent.py	Grammar fix in sample description bullet.
python/samples/03-workflows/agents/custom_agent_executors.py	Grammar fix in `Writer` docstring bullet list.
python/samples/02-agents/response_stream.py	Reflows markdown around “Pattern 3” and “Chaining” explanations.
python/samples/02-agents/providers/anthropic/anthropic_skills.py	Comment grammar fix.
python/samples/02-agents/observability/workflow_observability.py	Docstring grammar fix.
python/packages/orchestrations/agent_framework_orchestrations/_magentic.py	Docstring grammar fix.
python/packages/declarative/agent_framework_declarative/_workflows/_factory.py	Docstring grammar fix.
python/packages/declarative/agent_framework_declarative/_loader.py	Docstring grammar fixes across multiple factory methods.
python/packages/core/agent_framework/_workflows/_typing_utils.py	Docstring grammar fix.
python/packages/core/agent_framework/_agents.py	Docstring grammar fix for `Agent` initializers.
python/packages/ag-ui/tests/ag_ui/test_tooling.py	Test helper docstring grammar fix.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Reverts 79f5bc2 and 6306057. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

First

96c3712

Copilot AI balanced review requested due to automatic review settings October 2, 2026 18:15

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 18:15 — with GitHub Actions Inactive

Darren Cohen (dargilco) changed the title ~~Minor fix to response_stream.py sample~~ [Work in progress] Minor fix to response_stream.py sample Oct 2, 2026

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 18:15 — with GitHub Actions Inactive

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 18:21 — with GitHub Actions Inactive

Correct a Agent to an Agent

143e3cf

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 18:21 — with GitHub Actions Inactive

Correct a agent to an agent

8befc3b

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 18:22 — with GitHub Actions Inactive

Darren Cohen (dargilco) changed the title ~~[Work in progress] Minor fix to response_stream.py sample~~ [Work in progress] Minor fixes to code comments Oct 2, 2026

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 18:23 — with GitHub Actions Inactive

Copilot AI reviewed Oct 2, 2026

View reviewed changes

Comment thread python/samples/02-agents/response_stream.py

Comment thread python/samples/02-agents/response_stream.py

Comment thread python/samples/03-workflows/agents/group_chat_workflow_as_agent.py Outdated

Example 3 of response_stream.py, make sure we copy all properties

6306057

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 19:20 — with GitHub Actions Inactive

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 19:22 — with GitHub Actions Inactive

Show that cleanup happens at the end

13237a6

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 19:29 — with GitHub Actions Inactive

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 19:30 — with GitHub Actions Inactive

Also use copy() in example 5

79f5bc2

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 19:39 — with GitHub Actions Inactive

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 19:40 — with GitHub Actions Inactive

agent-framework-automation Bot added the python Usage: [Issues, PRs], Target: Python label Oct 2, 2026

Copilot started reviewing on behalf of Darren Cohen (dargilco) October 2, 2026 19:44

View session

Revert response stream copy examples

dd29baf

Reverts 79f5bc2 and 6306057. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 19:56 — with GitHub Actions Inactive

Update expected output at the end of response_stream.py

40088fe

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 2, 2026 20:13 — with GitHub Actions Inactive

Merge branch 'main' into dargilco/response_stream_sample

fdeadf7

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 8, 2026 20:18 — with GitHub Actions Inactive

move comment up:

558c166

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 8, 2026 20:34 — with GitHub Actions Inactive

agent-framework-automation Bot added the documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs label Oct 8, 2026

Updates to Foundry hosted agents README.md

9838f99

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 8, 2026 23:53 — with GitHub Actions Inactive

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 8, 2026 23:56 — with GitHub Actions Inactive

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 8, 2026 23:57 — with GitHub Actions Inactive

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 9, 2026 00:07 — with GitHub Actions Inactive

Darren Cohen (dargilco) marked this pull request as ready for review October 9, 2026 00:11

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 9, 2026 00:12 — with GitHub Actions Inactive

Darren Cohen (dargilco) changed the title ~~Python: Correct Agent wording and clarify response-stream examples~~ Python: Improve response-stream examples and polish Agent documentation Oct 9, 2026

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 9, 2026 01:23 — with GitHub Actions Inactive

Darren Cohen (dargilco) changed the title ~~Python: Improve response-stream examples and polish Agent documentation~~ Python: Minor updates to response-stream example and Foundry hosted agent doc Oct 9, 2026

Darren Cohen (dargilco) temporarily deployed to github-app-auth October 9, 2026 01:24 — with GitHub Actions Inactive

Eduard van Valkenburg (eavanvalkenburg) approved these changes Oct 9, 2026

View reviewed changes

Eduard van Valkenburg (eavanvalkenburg) added this pull request to the merge queue Oct 9, 2026

Merged via the queue into microsoft:main with commit 4e99842 Oct 9, 2026
55 checks passed

Navigation Menu

Repository navigation

Python: Minor updates to response-stream example and Foundry hosted agent doc - #8985

Python: Minor updates to response-stream example and Foundry hosted agent doc#8985
Eduard van Valkenburg (eavanvalkenburg) merged 12 commits into
microsoft:mainfrom
dargilco:dargilco/response_stream_sample

Darren Cohen (dargilco) commented Oct 2, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Darren Cohen (dargilco) commented Oct 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contribution Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Darren Cohen (dargilco) commented Oct 2, 2026 •

edited

Loading