Python: fix(devui): read context providers from the agent's provider list by tang-ontheway · Pull Request #10190 · microsoft/agent-framework

tang-ontheway · 2026-11-09T11:43:37Z

Motivation & Context

extract_agent_metadata() in agent_framework_devui._utils populated the context_provider field by reading the singular context_provider attribute:

if (
    hasattr(entity_object, "context_provider")
    and entity_object.context_provider
    and hasattr(entity_object.context_provider, "__class__")
):
    metadata["context_provider"] = [entity_object.context_provider.__class__.__name__]

Agent does not have a context_provider attribute — it stores the configured providers in the context_providers list (_agents.py: self.context_providers: list[ContextProvider] = list(context_providers or [])). The hasattr check therefore never matched for any framework agent, so metadata["context_provider"] stayed None.

Both discovery paths (_discovery.py: in-memory registration and directory discovery) read this field into EntityInfo.context_provider, which the DevUI frontend renders as the "Context Provider" card. The result is that an agent configured with, for example, InMemoryHistoryProvider() shows no context provider at all — the card is simply absent, with no error to hint at the cause.

Description & Review Guide

What are the major changes?
- extract_agent_metadata() now reads context_providers first and lists each configured provider's class name in the order they were configured.
- The singular context_provider attribute is kept as a fallback for custom agent objects that expose only that.
- Added python/packages/devui/tests/devui/test_agent_metadata.py covering a single configured provider, multiple providers (order preserved), an agent without providers, and the singular-attribute fallback.
What is the impact of these changes?
- EntityInfo.context_provider is now populated for framework agents that configure context providers, so the DevUI Context Provider card is rendered.
- No public API change: the metadata dict keeps the same context_provider key and the same list[str] | None shape.
- Agents without configured providers still report None, so the frontend keeps hiding the card for them.
What do you want reviewers to focus on?
- Whether the singular context_provider fallback is still worth keeping, given no framework agent exposes it.

Related Issue

Fixes #8989

AI Assistance

No material AI assistance was used.
This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: An AI coding assistant helped locate the metadata extraction path, draft the regression tests, and prepare this description. The analysis, the reproduction and the test results were verified by me against main at commit 7c2b31f.

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 links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
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.

extract_agent_metadata() read the singular `context_provider` attribute, but `Agent` stores its providers in the `context_providers` list. The `hasattr` check therefore never matched, so `EntityInfo.context_provider` stayed None even when providers were configured, and the DevUI Context Provider card was never rendered. Read `context_providers` first and keep the singular attribute as a fallback for custom agent objects that still expose it.

microsoft-github-policy-service · 2026-11-09T11:44:12Z

tang-ontheway please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copilot

🟡 Changes recommended

The provider-order test uses identically named classes, so it cannot detect reversed or sorted extraction and needs distinct classes with an exact sequence assertion.

1 open issue

Test provider extraction preserves configured order · New

What changed in this PR

Fixes #8989 by reading configured context providers from the framework agent’s provider list, allowing DevUI to display them without changing the metadata response shape.

Changes:

Extracts provider class names in configured order from context_providers.
Retains the singular context_provider fallback.
Adds tests for single, multiple, absent, and legacy providers.

File	Description
`python/packages/devui/tests/devui/test_agent_metadata.py`	Adds regression tests for provider metadata extraction.
`python/packages/devui/agent_framework_devui/_utils.py`	Reads the provider list while preserving the singular fallback and existing metadata key.

_{Review effort: Balanced}

+    agent = Agent(
+        client=Mock(model=None),
+        context_providers=[InMemoryHistoryProvider(), InMemoryHistoryProvider()],
+    )
+
+    metadata = extract_agent_metadata(agent)
+
+    assert metadata["context_provider"] == ["InMemoryHistoryProvider", "InMemoryHistoryProvider"]


Muhammad Abdullah Butt (1AbdullahButt)

Looks correct. Here's what I checked, plus two small cleanups.

The attribute name. Agent.__init__ stores self.context_providers: list[ContextProvider] = list(context_providers or []) (core/agent_framework/_agents.py:519). There's no singular context_provider anywhere in core, so the old hasattr check could never match a framework agent. Both discovery paths (_discovery.py:370 for in-memory registration, :863 for directory discovery) read agent_meta["context_provider"] into EntityInfo.context_provider: list[str] | None (models/_discovery_models.py:49). The shape doesn't change.
The empty case. An agent with no providers keeps None, so the frontend still hides the card.
The new tests. They build real Agent instances, not mocks, so they would catch a future rename of the attribute.
git merge-tree against main is clean.

Cleanups (optional):

hasattr(provider, "__class__") is always true. Every Python object has __class__, so the check can go, in both branches. The old code had the same no-op.
for provider in providers assumes an iterable. extract_agent_metadata is called on any registered entity, including custom SupportsAgentRun objects. One that exposes a truthy, non-iterable context_providers (a single provider object, a Mock()) would now raise TypeError out of entity discovery. The old code only read attributes. if isinstance(providers, (list, tuple)): keeps it as defensive as before.

One behaviour to know about, not a bug: Agent.run appends an InMemoryHistoryProvider to self.context_providers when a session is passed and no history provider is configured (_agents.py:1604-1615). Metadata taken at discovery won't show it, but metadata re-read after a run would. That's accurate, though it may surprise someone comparing the two.

I didn't run the tests.

Reviewed with help from Claude Code.

Address the review feedback on the DevUI context provider fix: - Drop the always-true ``hasattr(provider, "__class__")`` checks. - Only iterate ``context_providers`` when it is a list or tuple, so a truthy but non-iterable value no longer raises ``TypeError`` during entity discovery. - Use two distinct provider classes in the order test and assert the exact name sequence, so reversed or sorted extraction is detected. - Cover the non-iterable ``context_providers`` case with a regression test.

tang-ontheway · 2026-11-13T03:06:54Z

Thanks for the review — both cleanups are in (commit 950528b):

The __class__ check is gone in both branches (hasattr(provider, "__class__") is always true).
Non-iterable context_providers are now ignored instead of raising TypeError during entity discovery: the list is only iterated when it is a list or tuple, so a custom SupportsAgentRun object exposing a truthy but non-iterable context_providers keeps working like before. There is a new regression test for that case.

I also picked up the Copilot review comment on the order test: it now uses two distinct provider classes in non-alphabetical order (_ZebraProvider, _AardvarkProvider) and asserts the exact name sequence, so reversed or sorted extraction is detected.

On the InMemoryHistoryProvider note: agreed, that is a discovery-time snapshot, and metadata re-read after a run does show the appended history provider. I left the behaviour as is.

Local verification: pytest packages/devui/tests passes (all green), and ruff check / ruff format --check are clean on the changed files.

tang-ontheway requested review from SergeyMenshykh, Darren Cohen (dargilco), Eduard van Valkenburg (eavanvalkenburg), Jose Alvarez (jpalvarezl), Roger Barreto (rogerbarreto), sophia-ramsey and westey (westey-m) as code owners November 9, 2026 11:43

Copilot AI balanced review requested due to automatic review settings November 9, 2026 11:43

tang-ontheway temporarily deployed to github-app-auth November 9, 2026 11:43 — with GitHub Actions Inactive

tang-ontheway had a problem deploying to github-app-auth November 9, 2026 11:43 — with GitHub Actions Error

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

Copilot started reviewing on behalf of tang-ontheway November 9, 2026 11:44

View session

Copilot AI reviewed Nov 9, 2026

View reviewed changes

Muhammad Abdullah Butt (1AbdullahButt) reviewed Nov 12, 2026

View reviewed changes

tang-ontheway deployed to github-app-auth November 13, 2026 02:40 — with GitHub Actions Active

Merge main into fix/devui-discovery-context-providers

82dd8e8

tang-ontheway deployed to github-app-auth November 13, 2026 07:23 — with GitHub Actions Active

Navigation Menu

Repository navigation

Python: fix(devui): read context providers from the agent's provider list - #10190

Python: fix(devui): read context providers from the agent's provider list#10190
tang-ontheway wants to merge 3 commits into
microsoft:mainfrom
tang-ontheway:fix/devui-discovery-context-providers

tang-ontheway commented Nov 9, 2026

Uh oh!

microsoft-github-policy-service Bot commented Nov 9, 2026

Contribution License Agreement

Uh oh!

Copilot AI left a comment

Uh oh!

Muhammad Abdullah Butt (1AbdullahButt) left a comment

Uh oh!

tang-ontheway commented Nov 13, 2026

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

tang-ontheway commented Nov 9, 2026

Motivation & Context

Description & Review Guide

Related Issue

AI Assistance

Contribution Checklist

Uh oh!

microsoft-github-policy-service Bot commented Nov 9, 2026

Contribution License Agreement

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Muhammad Abdullah Butt (1AbdullahButt) left a comment

Choose a reason for hiding this comment

Uh oh!

tang-ontheway commented Nov 13, 2026

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants