Python: fix FoundryChatClient/FoundryAgent dropping default_headers

[he-yufeng]

Motivation and Context

Fixes #5416.

FoundryChatClient(default_headers=...) and FoundryAgent(default_headers=...) are documented to set additional HTTP headers on outbound requests. The constructor accepted the parameter, stored it on self.default_headers, and then forgot about it — the underlying AsyncOpenAI client was obtained via project_client.get_openai_client() without forwarding the headers, so custom headers never reached the wire.

This is a silent failure: the parameter looks wired up, existing unit test (test_init_with_default_header) even asserts the stored attribute is populated, but the reporter still spent hours tracking down why their header wasn't appearing in requests.

Description

AIProjectClient.get_openai_client(**kwargs) already forwards default_headers (and friends) to AsyncOpenAI, so the fix is just to pass them through from the two Foundry entry points:

• agent_framework_foundry/_chat_client.py (RawFoundryChatClient.__init__)
• agent_framework_foundry/_agent.py (FoundryAgent.__init__)

I deliberately didn't touch load_openai_service_settings in the shared openai package — while that is where the headers are dropped for the pre-built-client path, the reported bug is Foundry-specific and going through get_openai_client is the Azure-native way. The existing self.default_headers storage on the instance is kept intact for serialization/reflection.

Tests

• test_default_headers_forwarded_to_openai_client — regression test: asserts the headers actually land on the get_openai_client call.
• test_get_openai_client_not_called_with_headers_kwarg_when_unset — don't inject an empty dict when the user didn't ask for headers.
• Existing test_init_with_default_header still passes (storage attribute behavior unchanged).

Full foundry test suite: 102 passed, 14 skipped (skips are the integration tests needing a real endpoint).

Contribution Checklist

• The code builds clean without any errors or warnings
• The PR follows the Contribution Guidelines
• All unit tests pass, and I have added new tests where possible
• Is this a breaking change? No.

[moonbox3]

Python Test Coverage Report •

File	Stmts	Miss	Cover	Missing
packages/foundry/agent_framework_foundry
_agent.py	149	37	75%	183–184, 188–190, 195–198, 203, 296, 326–327, 339–340, 352–354, 356–357, 359–365, 367–368, 370, 372, 376–377, 564–565, 568, 610
_chat_client.py	154	19	87%	84, 86–88, 92–93, 97, 191, 226, 319, 380, 382, 480, 484–485, 487–490
TOTAL	29036	3475	88%

Python Unit Test Overview

Tests	Skipped	Failures	Errors	Time
5783	30 💤	0 ❌	0 🔥	1m 34s ⏱️

[TaoChenOSU]

I think we can also safely remove these

[he-yufeng]

Thanks for the approval @TaoChenOSU! The screenshot doesn't render for me in the API — just to make sure I'm removing the right thing, are you suggesting we also drop the now-redundant default_headers=default_headers kwarg from the two super().__init__(...) calls (_chat_client.py:214 and _agent.py:208)? Once the headers are forwarded through AsyncOpenAI, the parent's self.default_headers is a dead store — nothing in packages/openai or packages/foundry reads it back (grepped), it's just recorded "for serialization" in _chat_client.py:454-459 with no consumer.

If that's the intent, I'll push a follow-up that also removes test_init_with_default_header in test_foundry_chat_client.py, since it currently asserts exactly that parent-side self.default_headers bookkeeping. Let me know and I'll turn it around.

[moonbox3]

@he-yufeng 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

@he-yufeng please accept the CLA

[eavanvalkenburg]

Closing this, as it is already done, with additional setup for the new hosted agents in #5447