[docs] Update Foundry Local docs to reflect CLI-based lifecycle (aspire#17889)#1210
Conversation
The Foundry Local integration now uses the installed 'foundry' CLI (foundry service start/stop/list and foundry model download/load) instead of the FoundryLocalManager in-proc APIs. Aspire manages the entire service lifecycle automatically. Update docs to: - Clarify users do not need to pre-start Foundry Local - State that the 'foundry' CLI must be on PATH - Describe the automatic start/stop lifecycle management Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
IEvangelist
left a comment
There was a problem hiding this comment.
Docs-from-code reviewer — branch mismatch, cannot verify
This PR targets release/13.5 on microsoft/aspire.dev, but microsoft/aspire has no matching release/13.5 branch (latest release branch upstream is release/13.4 at 59e06a48d2b09bc2b3efa6ac9ea6b38336b88c4b).
The referenced source PR, microsoft/aspire#17889, was merged into main as commit 6518fb56fe0cf63a23fc86767c6181352903e68c. Per this reviewer's rules I only verify against the matching release branch, so I'm skipping claim verification (Phase A) and the doc-tester run (Phase B) for this PR.
Once release/13.5 exists in microsoft/aspire (or this PR is retargeted to a branch that does exist there, e.g. release/13.4), I'll perform the full review on the next hourly run.
Head SHA reviewed: ea7d912dc61f7348d9755f4e44d4fa8a3aecfb12
There was a problem hiding this comment.
Pull request overview
Updates the Azure AI Foundry integration documentation to reflect the newer Foundry Local behavior where Aspire manages the local service lifecycle via the installed foundry CLI (instead of requiring users to pre-start the service).
Changes:
- Replaces the outdated “Foundry Local installed and running” prerequisite with “
foundryCLI installed and onPATH”. - Describes Aspire-managed lifecycle steps (start, endpoint discovery, model download/load, shutdown) for Foundry Local.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
IEvangelist
left a comment
There was a problem hiding this comment.
Source-of-truth branch mismatch — review skipped (re-review of new revision)
Cannot verify this PR against microsoft/aspire.
This is a re-review after new commits landed (ea7d912d → a7963b64). The branch-mismatch condition that blocked my prior review is unchanged.
PR base branch (microsoft/aspire.dev) |
release/13.5 |
Matching branch in microsoft/aspire |
does not exist |
Latest release branch in microsoft/aspire |
release/13.4 (4f2189335) |
| Source PR cited in body | microsoft/aspire#17889 — merged to main, milestone 13.5 |
My review protocol requires using the matching microsoft/aspire release branch as the single source of truth for claim verification. Because no release/13.5 branch exists on microsoft/aspire yet (13.5 has not been cut), I cannot verify the API/CLI/config claims in this PR against an authoritative source code snapshot for that release.
The PR body itself notes the same issue ("Targeting release/13.4 … because release/13.5 … does not exist there"), even though the actual base ended up being release/13.5 on aspire.dev. Possible resolutions:
- Re-target this PR to
release/13.4inaspire.dev(matches what the body already says was intended, and what currently exists upstream). - Wait until
release/13.5is cut inmicrosoft/aspire, then re-run review against that branch.
Skipping Phase B (doc-tester) as well — running it without the Phase A claim verification would produce an incomplete review per protocol.
Documents changes from microsoft/aspire#17889 by
@sebastienros.Targeting
release/13.4— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.5(from the source PR milestone13.5) does not exist there.Why this PR is needed
PR microsoft/aspire#17889 upgraded the Foundry Local integration to
Microsoft.AI.Foundry.Local1.1.0. The runtime implementation changed from using in-processFoundryLocalManagerAPIs to invoking the installedfoundryCLI for the full service lifecycle (foundry service start,foundry service stop,foundry service list,foundry model download,foundry model load).The existing docs stated:
This is now incorrect. Aspire manages the full lifecycle — users do not pre-start the service. The requirement is that the
foundryCLI be installed and available onPATH.What changed
Updated the "Use Foundry Local for development" section of
azure-ai-foundry-host.mdxto:foundry service start/foundry service stop).foundryCLI must be installed and onPATH.Files modified
src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-host.mdx— updated "Use Foundry Local for development" section