Python: Docs: Fix broken external links in Python samples and docs - #8090
Open
Shxiao (Shxiao101) wants to merge 2 commits into
Open
Python: Docs: Fix broken external links in Python samples and docs#8090Shxiao (Shxiao101) wants to merge 2 commits into
Shxiao (Shxiao101) wants to merge 2 commits into
Conversation
Shxiao (Shxiao101)
requested review from
SergeyMenshykh,
Tao Chen (TaoChenOSU),
Vincent Biret (baywet),
chetantoshniwal,
Eduard van Valkenburg (eavanvalkenburg),
Giles Odigwe (giles17),
Jose Alvarez (jpalvarezl),
Evan Mattson (moonbox3),
Peter Ibekwe (peibekwe),
Roger Barreto (rogerbarreto) and
westey (westey-m)
as code owners
September 5, 2026 14:30
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
Correct the Toolbox target description so it does not promise guidance absent from that page.
Pull request overview
Fixes broken external links across Python samples, ChatKit documentation, and an ADR.
Changes:
- Updates relocated Foundry Toolbox resources and authentication guides.
- Redirects the ChatKit integration guide.
- Updates the Google API Core source citation.
File summaries
| File | Description |
|---|---|
python/samples/04-hosting/foundry-hosted-agents/responses/foundry_toolbox/README.md |
Updates moved Toolbox resources and guides. |
python/packages/chatkit/README.md |
Updates the ChatKit integration link. |
docs/decisions/0033-feature-usage-bitmask-user-agent.md |
Updates the Google API Core citation. |
Review details
Suppressed comments (1)
python/samples/04-hosting/foundry-hosted-agents/responses/foundry_toolbox/README.md:134
- The new
toolbox.mdtarget does not contain the OAuth consent or citation guidance attributed to it; those details are in the separateuse-toolbox-in-hosted-agent.mdpage linked below. Please describe this target as the conceptual/schema reference so readers are not sent to the wrong page for the promised guidance.
> - [Toolbox reference](https://github.com/microsoft/GitHub-Copilot-for-Azure/blob/main/plugins/azure-skills/skills/microsoft-foundry/foundry-agent/toolbox/toolbox.md) — endpoint format, MCP protocol, OAuth consent handling, citation patterns, and troubleshooting.
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Author
|
@microsoft-github-policy-service agree |
Ricky-7-Yan
approved these changes
Sep 5, 2026
Ricky-7-Yan
left a comment
Contributor
There was a problem hiding this comment.
Verified the current head independently:
- All 11 distinct replacement URLs return HTTP 200 (12 changed occurrences).
- The ChatKit target contains the
Generate model responsessection and documents the response-streaming integration referenced here. - The five Foundry scenario pages match the README's no-auth, key, managed OAuth, agent identity / Microsoft Entra, and user Entra pass-through descriptions.
- The follow-up commit correctly narrows
toolbox.mdto its actual concept/API/schema scope while leaving integration guidance on the dedicated hosted-agent page.
No blocking issues found in the current diff.
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.
Motivation & Context
A link check found 11 dead external URLs (12 occurrences) in 3 files — all verified to return 404, concentrated in the Foundry hosted-agents toolbox sample, the ChatKit package README, and one ADR. Every replacement URL was verified to return 200 before submission. Fixes #8089.
Description & Review Guide
python/samples/04-hosting/foundry-hosted-agents/responses/foundry_toolbox/README.md: theazure-ai-projectstoolbox CRUD sample moved fromsamples/hosted_agents/tosamples/toolboxes/;SUPPORTED_TOOLBOX_SCENARIOS.mdbecame a directory of per-scenario guides, so the five auth-scenario anchors now map 1:1 totools/mcp-unauthenticated.md,tools/mcp-key-auth.md,tools/mcp-oauth-managed.md,tools/mcp-microsoft-entra.md, andtools/mcp-user-entra-token.md(plus the indexREADME.md); the two GitHub Copilot for Azure skill references moved fromplugin/skills/...toplugins/azure-skills/skills/..., withtoolbox-reference.mdconsolidated intotoolbox/toolbox.md.python/packages/chatkit/README.md: theAgent SDK integrationsection ofdocs/server.mdnow lives indocs/quickstart.md#generate-model-responses(same helpers, includingstream_agent_response).docs/decisions/0033-feature-usage-bitmask-user-agent.md:google-api-coremoved into thegoogleapis/google-cloud-pythonmonorepo, so theclient_info.pyprior-art citation points there now.toolbox/toolbox.mdis the right consolidation target for the oldtoolbox-reference.md.Related Issue
Fixes #8089
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.Prepared with AI coding assistance; all links were individually verified (404 → 200) and the change reviewed by me.