.NET: Add Foundry Deployment docs to HA sample READMEs#6365
Conversation
…agent samples This commit adds comprehensive deployment documentation to all 13 .NET Foundry hosted agent samples that were missing it. Each sample now includes: - Instructions to initialize an azd project from the sample's agent.manifest.yaml - Steps to deploy using 'azd deploy' - Example environment variable overrides for customization - Link to the official Foundry deployment guide Samples updated: - Hosted-LocalTools - Hosted-Files - Hosted-FoundryAgent - Hosted-McpTools - Hosted-Observability - Hosted-MemoryAgent - Hosted-TextRag - Hosted-ToolboxMcpSkills - Hosted-AzureSearchRag - Hosted-AgentSkills - Hosted-Workflow-Handoff - Hosted-Workflow-Simple - Hosted-Invocations-EchoAgent Each section includes the correct agent name from the sample's manifest and points to the correct GitHub URL for initializing the azd project. Fixes: microsoft#6308 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Automated Code Review
Reviewers: 4 | Confidence: 61%
✓ Correctness
This documentation-only PR adds deployment instructions to 14 README files. All referenced agent.manifest.yaml and agent.yaml files exist at the documented paths. The AGENT_NAME values used in the
azd env setexamples match thename:field in each sample's agent.manifest.yaml. URLs point to correct GitHub paths. No correctness issues found.
✓ Security Reliability
This PR adds deployment documentation sections to 14 .NET Foundry hosted agent sample READMEs. All changes are purely documentation (markdown). The referenced agent.manifest.yaml files exist at the paths specified in the URLs. No code changes, no secrets exposure, no injection risks, and no reliability concerns. The documentation correctly points users to official Microsoft Learn guides and uses standard azd CLI commands.
✓ Test Coverage
This PR adds only documentation (README.md sections) to 14 sample projects describing how to deploy to Foundry using azd. There are no code changes, no new behavior, no modified logic, and no testable surface area. Test coverage review is not applicable to pure markdown documentation additions.
✗ Design Approach
The new deployment docs are mostly consistent, but one sample now has two conflicting deployment instructions. In
Hosted-AgentSkills, the newly added generic azd block omits the sample-specificSKILL_NAMESrequirement that the same README already documents and that the manifest declares as a deployment parameter, so the current approach no longer addresses this sample’s deployment story in a single consistent way.
Flagged Issues
-
dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-AgentSkills/README.mdnow has conflicting deployment guidance: the pre-existing section saysSKILL_NAMESmust be set for deployment (lines 99-104), andagent.manifest.yaml:28-37declares it as a manifest parameter, but the new azd block only showsAGENT_NAMEandAZURE_AI_MODEL_DEPLOYMENT_NAME.
Automated review by alliscode's agents
There was a problem hiding this comment.
Pull request overview
This PR adds Azure Developer CLI (azd) deployment guidance to the .NET Foundry Hosted Agent sample READMEs, helping readers initialize from each sample’s agent.manifest.yaml and deploy with azd deploy.
Changes:
- Added a “Deploying to Foundry (azd spec)” section across the Hosted Agent samples with
azd ai agent init+azd deploysteps. - Added example
azd env set ...overrides and a link to the official hosted-agent deployment guide. - Standardized the deployment snippet shape across the touched READMEs (responses + invocations).
Show a summary per file
| File | Description |
|---|---|
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-Workflow-Simple/README.md | Adds azd-based Foundry deployment steps for the simple workflow sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-Workflow-Handoff/README.md | Adds azd-based Foundry deployment steps for the handoff workflow sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-ToolboxMcpSkills/README.md | Adds azd-based Foundry deployment steps for the Toolbox MCP Skills sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-TextRag/README.md | Adds azd-based Foundry deployment steps for the Text RAG sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-Observability/README.md | Adds azd-based Foundry deployment steps for the observability sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-MemoryAgent/README.md | Adds azd-based Foundry deployment steps for the memory sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-McpTools/README.md | Adds azd-based Foundry deployment steps for the MCP tools sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-LocalTools/README.md | Adds azd-based Foundry deployment steps for the local tools sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-FoundryAgent/README.md | Adds azd-based Foundry deployment steps for the Foundry-managed agent sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-Files/README.md | Adds azd-based Foundry deployment steps for the files sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-ChatClientAgent/README.md | Adds azd-based Foundry deployment steps for the chat-client sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-AzureSearchRag/README.md | Adds azd-based Foundry deployment steps for the Azure AI Search RAG sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/responses/Hosted-AgentSkills/README.md | Adds azd-based Foundry deployment steps for the Agent Skills sample. |
| dotnet/samples/04-hosting/FoundryHostedAgents/invocations/Hosted-Invocations-EchoAgent/README.md | Adds azd-based Foundry deployment steps for the invocations echo sample. |
Copilot's findings
- Files reviewed: 14/14 changed files
- Comments generated: 3
|
|
||
| > The `skills/` source folder is **not** deployed to Foundry — only the downloaded skills are used at runtime. The provisioning step must have been run against the same Foundry project before the agent can download the skills. | ||
|
|
||
| ## Deploying to Foundry (azd spec) |
|
|
||
| ```bash | ||
| azd env set AGENT_NAME hosted-toolbox-mcp-skills | ||
| azd env set AZURE_AI_MODEL_DEPLOYMENT_NAME gpt-4o |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…agent samples
This commit adds comprehensive deployment documentation to all 13 .NET Foundry hosted agent samples that were missing it. Each sample now includes:
Samples updated:
Each section includes the correct agent name from the sample's manifest and points to the correct GitHub URL for initializing the azd project.
Fixes: #6308
Contribution Checklist