Skip to content

Commit ae60814

Browse files
docs(hosted-agents): collapse Foundry Toolkit section and neutralize azd recommendations (#585)
* docs(hosted-agents): collapse Foundry Toolkit section and neutralize azd recs Minimal README updates across the python and csharp hosted-agents samples: collapse the 'Using the Foundry Toolkit VS Code Extension' section into a <details> block, drop azd 'Recommended'/'recommended' qualifiers, and rename 'Without azd' to 'Manual setup' (with anchor fixes). H1 headers, descriptions, and other section content are left unchanged. * docs(hosted-agents): revert Python overview README
1 parent 0f248f1 commit ae60814

41 files changed

Lines changed: 339 additions & 222 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODEOWNERS

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@
1111
/samples/python/foundry-local/ @microsoft-foundry/foundry-local
1212
/samples/rust/foundry-local/ @microsoft-foundry/foundry-local
1313

14+
#### Partner / external collaborator sample areas #######################################################
15+
# Partners are outside collaborators (not org members). Each entry is the source of truth for that
16+
# partner. Update alongside step 3 of the onboarding process in docs/external-contributions.md.
17+
#
18+
# Format:
19+
# # <Partner name> — onboarded: YYYY-MM-DD — partner: @<partner-github> — dri: @<dri-github>
20+
# /samples/<language>/<partner-area>/ @<dri-github>
21+
#
22+
# Mistral AI — add entry here once DRI and sample paths are confirmed:
23+
# # Mistral AI — onboarded: 2026-06-22 — partner: @peymanmohajerian — dri: @truptiparkar7
24+
# /samples/python/mistral/ @FILL_IN
25+
1426
#### files referenced in docs (DO NOT EDIT, except for Docs team!!!) ##########################################
1527
/infrastructure/infrastructure-setup-bicep/01-connections/connection-key-vault.bicep @microsoft-foundry/AI-Platform-Docs
1628
/infrastructure/infrastructure-setup-bicep/05-custom-policy-definitions/deny-disallowed-connections.json @microsoft-foundry/AI-Platform-Docs

samples/csharp/hosted-agents/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,8 @@ azd up
222222
azd down
223223
```
224224

225-
### Using the Foundry Toolkit VS Code Extension
225+
<details>
226+
<summary><h3>Using the Foundry Toolkit VS Code Extension</h3></summary>
226227

227228
The [Foundry Toolkit VS Code extension](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=vscode) has a built-in sample gallery. You can open any sample directly from the extension without cloning this repository, it scaffolds the project into a new workspace, generates `agent.yaml`, `.env`, and `.vscode/tasks.json` + `launch.json` automatically, and configures a one-click **F5** debug experience.
228229

@@ -238,6 +239,8 @@ Or, if you've already cloned this repository:
238239

239240
The extension builds the container image in ACR (or uploads the ZIP), creates the agent version, and assigns required RBAC roles automatically.
240241

242+
</details>
243+
241244
### Other ways to invoke your agent
242245

243246
| Method | When to use |

samples/csharp/hosted-agents/agent-framework/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,8 @@ Or in PowerShell:
130130
(Invoke-WebRequest -Uri http://localhost:8088/responses -Method POST -ContentType "application/json" -Body '{"input": "Hello!"}').Content
131131
```
132132

133-
### Using the Foundry Toolkit VS Code Extension
133+
<details>
134+
<summary><h3>Using the Foundry Toolkit VS Code Extension</h3></summary>
134135

135136
The [Foundry Toolkit VS Code extension](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=vscode) has a built-in sample gallery. You can open this sample directly from the extension without cloning the repository, it scaffolds the project into a new workspace, generates `agent.yaml`, `.env`, and `.vscode/tasks.json` + `launch.json` automatically, and configures a one-click **F5** debug experience.
136137

@@ -149,6 +150,8 @@ With the agent running on `http://localhost:8088/`:
149150
2. The Inspector auto-connects to the running agent.
150151
3. Send messages from the Inspector to chat with the agent and watch the streamed responses.
151152

153+
</details>
154+
152155
### Using `dotnet run`
153156

154157
#### Prerequisites

samples/csharp/hosted-agents/agent-framework/agent-skills/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ See [Program.cs](Program.cs) for the full implementation.
5050

5151
Before running this sample, ensure you have:
5252

53-
1. **Azure Developer CLI (`azd`)** (recommended)
53+
1. **Azure Developer CLI (`azd`)**
5454
- [Install azd](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) (1.25 or later) and the unified Foundry CLI extension: `azd ext install microsoft.foundry`
5555
- Authenticated: `azd auth login`
5656

@@ -62,7 +62,7 @@ Before running this sample, ensure you have:
6262
- Download from [https://dotnet.microsoft.com/download](https://dotnet.microsoft.com/download)
6363

6464
> [!NOTE]
65-
> You do **not** need an existing [Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/what-is-foundry?view=foundry) project or model deployment to get started — `azd provision` creates them for you. If you already have a project, see the [note below](#using-azd-recommended-for-cli-workflows) on how to target it.
65+
> You do **not** need an existing [Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/what-is-foundry?view=foundry) project or model deployment to get started — `azd provision` creates them for you. If you already have a project, see the [note below](#using-azd) on how to target it.
6666
6767
### Required RBAC
6868

@@ -102,15 +102,18 @@ dotnet restore
102102

103103
### Running the Sample
104104

105-
The recommended way to run and test hosted agents locally is with the Azure Developer CLI (`azd`) or the Foundry VS Code extension.
105+
Run and test hosted agents locally with the Azure Developer CLI (`azd`) or the Foundry VS Code extension.
106106

107-
#### Using the Foundry VS Code Extension
107+
<details>
108+
<summary><h4>Using the Foundry VS Code Extension</h4></summary>
108109

109110
The [Foundry VS Code extension](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=vscode) has a built-in sample gallery. You can open this sample directly from the extension without cloning the repository — it scaffolds the project into a new workspace, generates `agent.yaml`, `.env`, and `.vscode/tasks.json` + `launch.json` automatically, and configures a one-click **F5** debug experience.
110111

111112
Follow the [VS Code quickstart](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=vscode) for a full step-by-step walkthrough.
112113

113-
#### Using [`azd`](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=azd) (recommended for CLI workflows)
114+
</details>
115+
116+
#### Using [`azd`](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=azd)
114117

115118
No cloning required. Create a new folder, point `azd` at the manifest on GitHub, and it sets up the sample and generates Bicep infrastructure, `agent.yaml`, and env config automatically:
116119

@@ -169,7 +172,7 @@ curl -sS -X POST http://localhost:8088/responses \
169172

170173
Because skills are loaded on demand, the canary token in a response also proves the model actually invoked `load_skill` for the matching skill — not just saw its name in the advertised list.
171174

172-
#### Without `azd`
175+
#### Manual setup
173176

174177
If running without `azd`, set environment variables manually (see [Environment Variables](#environment-variables)), then:
175178

@@ -212,7 +215,7 @@ For the full deployment guide, see [Azure AI Foundry hosted agents](https://aka.
212215

213216
### Images built on Apple Silicon or other ARM64 machines do not work on our service
214217

215-
We **recommend deploying with `azd deploy`**, which uses ACR remote build and always produces images with the correct architecture.
218+
**Deploy with `azd deploy`**, which uses ACR remote build and always produces images with the correct architecture.
216219

217220
If you choose to **build locally**, and your machine is **not `linux/amd64`** (for example, an Apple Silicon Mac), the image will **not be compatible with our service**, causing runtime failures.
218221

samples/csharp/hosted-agents/agent-framework/azure-search-rag/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ See [Program.cs](Program.cs) for the full implementation.
2323

2424
Before running this sample, ensure you have:
2525

26-
1. **Azure Developer CLI (`azd`)** (recommended)
26+
1. **Azure Developer CLI (`azd`)**
2727
- [Install azd](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) (1.25 or later) and the unified Foundry CLI extension: `azd ext install microsoft.foundry`
2828
- Authenticated: `azd auth login`
2929

@@ -35,7 +35,7 @@ Before running this sample, ensure you have:
3535
- Download from [https://dotnet.microsoft.com/download](https://dotnet.microsoft.com/download)
3636

3737
> [!NOTE]
38-
> You do **not** need an existing [Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/what-is-foundry?view=foundry) project, model deployment, or Azure AI Search service to get started, `azd provision` creates them all for you. If you already have some of these, see the [note below](#using-azd-recommended-for-cli-workflows) on how to target them.
38+
> You do **not** need an existing [Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/what-is-foundry?view=foundry) project, model deployment, or Azure AI Search service to get started, `azd provision` creates them all for you. If you already have some of these, see the [note below](#using-azd) on how to target them.
3939
4040
### Environment Variables
4141

@@ -73,19 +73,22 @@ dotnet restore
7373

7474
### Running the Sample
7575

76-
The recommended way to run and test hosted agents locally is with the Azure Developer CLI (`azd`) or the Foundry Toolkit VS Code extension.
76+
Run and test hosted agents locally with the Azure Developer CLI (`azd`) or the Foundry Toolkit VS Code extension.
7777

78-
#### Using the Foundry Toolkit VS Code Extension
78+
<details>
79+
<summary><h4>Using the Foundry Toolkit VS Code Extension</h4></summary>
7980

8081
The [Foundry Toolkit VS Code extension](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=vscode) has a built-in sample gallery. You can open this sample directly from the extension without cloning the repository, it scaffolds the project into a new workspace, generates `agent.yaml`, `.env`, and `.vscode/tasks.json` + `launch.json` automatically, and configures a one-click **F5** debug experience.
8182

8283
Chat with a running agent using the **Agent Inspector**:
8384

84-
1. Start the agent locally first using **Using `azd`** or **Without `azd`** above. The agent listens on `http://localhost:8088/`.
85+
1. Start the agent locally first using **Using `azd`** or **Manual setup** above. The agent listens on `http://localhost:8088/`.
8586
2. Open the Command Palette (`Ctrl+Shift+P`) and run **Foundry Toolkit: Open Agent Inspector**.
8687
3. The Inspector auto-connects to the running agent. Send messages to chat with the agent and watch the streamed responses.
8788

88-
#### Using [`azd`](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=azd) (recommended for CLI workflows)
89+
</details>
90+
91+
#### Using [`azd`](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=azd)
8992

9093
No cloning required. Create a new folder, point `azd` at the manifest on GitHub, and it sets up the sample, generates Bicep infrastructure, `agent.yaml`, and env config:
9194

@@ -128,7 +131,7 @@ Tracking issue: [Azure-Samples/azd-ai-starter-basic — make storage optional in
128131
> `azd ai agent init -m <path-to-repo>/samples/csharp/hosted-agents/agent-framework/azure-search-rag/agent.manifest.yaml`
129132

130133
> [!NOTE]
131-
> If you already have a Foundry project, model deployment, and Azure AI Search service, add `-p <project-id> -d <deployment-name>` to `azd ai agent init` to target existing resources. You can also skip provisioning entirely and configure env vars manually, see [Without `azd`](#without-azd).
134+
> If you already have a Foundry project, model deployment, and Azure AI Search service, add `-p <project-id> -d <deployment-name>` to `azd ai agent init` to target existing resources. You can also skip provisioning entirely and configure env vars manually, see [Manual setup](#manual-setup).
132135

133136
The agent starts on `http://localhost:8088/`. To invoke it:
134137

@@ -152,7 +155,7 @@ curl -sS -X POST http://localhost:8088/responses \
152155
-d '{"input": "How do I clean my tent?", "stream": false}' | jq .
153156
```
154157

155-
#### Without `azd`
158+
#### Manual setup
156159

157160
If running without `azd`, set environment variables manually (see [Environment Variables](#environment-variables)), then:
158161

@@ -335,7 +338,7 @@ Wait ~3 minutes for AAD propagation before invoking the agent.
335338

336339
### Images built on Apple Silicon or other ARM64 machines do not work on our service
337340

338-
We **recommend deploying with `azd deploy`**, which uses ACR remote build and always produces images with the correct architecture.
341+
**Deploy with `azd deploy`**, which uses ACR remote build and always produces images with the correct architecture.
339342

340343
If you choose to **build locally**, and your machine is **not `linux/amd64`** (for example, an Apple Silicon Mac), the image will **not be compatible with our service**, causing runtime failures.
341344

samples/csharp/hosted-agents/agent-framework/file-tools/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ See [Program.cs](Program.cs) for the full implementation.
3232

3333
Before running this sample, ensure you have:
3434

35-
1. **Azure Developer CLI (`azd`)** (recommended)
35+
1. **Azure Developer CLI (`azd`)**
3636
- [Install azd](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) (1.25 or later) and the unified Foundry CLI extension: `azd ext install microsoft.foundry`
3737
- Authenticated: `azd auth login`
3838

@@ -44,7 +44,7 @@ Before running this sample, ensure you have:
4444
- Download from [https://dotnet.microsoft.com/download](https://dotnet.microsoft.com/download)
4545

4646
> [!NOTE]
47-
> You do **not** need an existing [Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/what-is-foundry?view=foundry) project or model deployment to get started — `azd provision` creates them for you. If you already have a project, see the [note below](#using-azd-recommended-for-cli-workflows) on how to target it.
47+
> You do **not** need an existing [Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/what-is-foundry?view=foundry) project or model deployment to get started — `azd provision` creates them for you. If you already have a project, see the [note below](#using-azd) on how to target it.
4848
4949
### Environment Variables
5050

@@ -80,19 +80,22 @@ dotnet restore
8080

8181
### Running the Sample
8282

83-
The recommended way to run and test hosted agents locally is with the Azure Developer CLI (`azd`) or the Foundry Toolkit VS Code extension.
83+
Run and test hosted agents locally with the Azure Developer CLI (`azd`) or the Foundry Toolkit VS Code extension.
8484

85-
#### Using the Foundry Toolkit VS Code Extension
85+
<details>
86+
<summary><h4>Using the Foundry Toolkit VS Code Extension</h4></summary>
8687

8788
The [Foundry Toolkit VS Code extension](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=vscode) has a built-in sample gallery. You can open this sample directly from the extension without cloning the repository, it scaffolds the project into a new workspace, generates `agent.yaml`, `.env`, and `.vscode/tasks.json` + `launch.json` automatically, and configures a one-click **F5** debug experience.
8889

8990
Chat with a running agent using the **Agent Inspector**:
9091

91-
1. Start the agent locally first using **Using `azd`** or **Without `azd`** above. The agent listens on `http://localhost:8088/`.
92+
1. Start the agent locally first using **Using `azd`** or **Manual setup** above. The agent listens on `http://localhost:8088/`.
9293
2. Open the Command Palette (`Ctrl+Shift+P`) and run **Foundry Toolkit: Open Agent Inspector**.
9394
3. The Inspector auto-connects to the running agent. Send messages to chat with the agent and watch the streamed responses.
9495

95-
#### Using [`azd`](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=azd) (recommended for CLI workflows)
96+
</details>
97+
98+
#### Using [`azd`](https://learn.microsoft.com/en-us/azure/foundry/agents/quickstarts/quickstart-hosted-agent?view=foundry&pivots=azd)
9699

97100
No cloning required. Create a new folder, point `azd` at the manifest on GitHub, and it sets up the sample and generates Bicep infrastructure, `agent.yaml`, and env config automatically:
98101

@@ -116,7 +119,7 @@ azd ai agent run
116119
> `azd ai agent init -m <path-to-repo>/samples/csharp/hosted-agents/agent-framework/file-tools/agent.manifest.yaml`
117120
118121
> [!NOTE]
119-
> If you already have a Foundry project and model deployment, add `-p <project-id> -d <deployment-name>` to `azd ai agent init` to target existing resources. You can also skip provisioning entirely and configure env vars manually — see [Without `azd`](#without-azd).
122+
> If you already have a Foundry project and model deployment, add `-p <project-id> -d <deployment-name>` to `azd ai agent init` to target existing resources. You can also skip provisioning entirely and configure env vars manually — see [Manual setup](#manual-setup).
120123
121124
The agent starts on `http://localhost:8088/`.
122125

@@ -147,7 +150,7 @@ azd ai agent invoke --local "Read the file at the path '../../../etc/passwd' fro
147150

148151
The agent's tool schema only accepts a `fileName` (no `path`), and the `Path.GetFileName` + `StartsWith(root)` defence in depth rejects anything that resolves outside the tool's root. The agent will refuse and explain that only the bundled files are available.
149152

150-
#### Without `azd`
153+
#### Manual setup
151154

152155
If running without `azd`, set environment variables manually (see [Environment Variables](#environment-variables)), then:
153156

@@ -208,7 +211,7 @@ Drop additional text files into [`resources/`](./resources/). The csproj `<Conte
208211

209212
### Images built on Apple Silicon or other ARM64 machines do not work on our service
210213

211-
We **recommend deploying with `azd deploy`**, which uses ACR remote build and always produces images with the correct architecture.
214+
**Deploy with `azd deploy`**, which uses ACR remote build and always produces images with the correct architecture.
212215

213216
If you choose to **build locally**, and your machine is **not `linux/amd64`** (for example, an Apple Silicon Mac), the image will **not be compatible with our service**, causing runtime failures.
214217

0 commit comments

Comments
 (0)