Skip to content

Commit 7f8afb4

Browse files
authored
AITK v0-16-1 docs update (#8588)
* Initial changes * updates based on feredback * update link * updated based on feedback * Updated based on feedback
1 parent e45b387 commit 7f8afb4

Some content is hidden

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

65 files changed

+165
-118
lines changed

docs/intelligentapps/agentbuilder.md

Lines changed: 50 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
ContentId: bd3d7555-3d84-4500-ae95-6dcd39641af0
3-
DateApproved: 06/16/2025
3+
DateApproved: 07/14/2025
44
MetaDescription: Get Started with creating, iterating and optimizing your agents in AI Toolkit.
55
---
66
# Build agents and prompts in AI Toolkit
77

88
> [!NOTE]
9-
> Agent Builder was previously known as Prompt Builder. The name has been changed to better reflect the feature's capabilities and its focus on building agents.
9+
> Agent Builder was previously known as Prompt Builder. The updated name better reflects the feature's capabilities and its focus on building agents.
1010
1111
Agent Builder in AI Toolkit streamlines the engineering workflow for building agents, including prompt engineering and integration with tools, such as MCP servers. It helps with common prompt engineering tasks:
1212
- Generate starter prompts
@@ -25,22 +25,22 @@ Agent Builder also enhances intelligent app's capabilities with tool use:
2525

2626
To access Agent Builder, use either of these options:
2727

28-
- In the AI Toolkit view, select **Agent (Prompt) Builder**
29-
- Select **Try in Agent (Prompt) Builder** from a model card in the model catalog
28+
- In the AI Toolkit view, select **Agent Builder**
29+
- Select **Try in Agent Builder** from a model card in the model catalog
3030

3131
To test a prompt in Agent Builder, follow these steps:
3232

3333
1. In **Models**, select a model from the dropdown list, or select **Browse models** to add another model from the model catalog.
3434

35-
![Screenshot showing the model selection dropdown in Agent Builder.](./images/promptbuilder/select_models.png)
35+
![Screenshot showing the model selection dropdown in Agent Builder.](./images/promptbuilder/select-models.png)
3636

3737
1. Enter a **User prompt** and optionally enter a **System prompt**.
3838

3939
The *user prompt* is the input that you want to send to the model. The optional *system prompt* is used to provide instructions with relevant context to guide the model response.
4040

4141
> [!TIP]
4242
> Describe your project idea using natural language to generate prompts automatically.
43-
> ![Screenshot showing natural language prompt generation in Agent Builder.](./images/promptbuilder/generate_prompt_2.gif)
43+
> ![Screenshot showing natural language prompt generation in Agent Builder.](./images/promptbuilder/generate-prompt-2.gif)
4444
4545
3. Select **Run** to send the prompts to the model.
4646

@@ -51,11 +51,11 @@ To test a prompt in Agent Builder, follow these steps:
5151
## Use MCP servers
5252
MCP server is a tool that allows you to connect to external APIs and services, enabling your agent to perform actions beyond just generating text. For example, you can use an MCP server to access databases, call web services, or interact with other applications.
5353

54-
You can use the agent builder to discover and configure featured MCP servers, connect to existing MCP servers or build a new MCP server from scaffold.
54+
Use the agent builder to discover and configure featured MCP servers, connect to existing MCP servers, or build a new MCP server from scaffold.
5555

5656
> [!NOTE]
57-
> Using MCP servers may require either [Node](https://nodejs.org/en/download) or [Python](https://www.python.org/downloads/) environment. AI Toolkit will validate your environment to ensure that the required dependencies are installed.
58-
> After installing, please use the command `npm install -g npx` to install `npx`. If you prefer Python, we recommend using [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
57+
> Using MCP servers might require either [Node](https://nodejs.org/en/download) or [Python](https://www.python.org/downloads/) environment. AI Toolkit validates your environment to ensure that the required dependencies are installed.
58+
> After installing, use the command `npm install -g npx` to install `npx`. If you prefer Python, we recommend using [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
5959
6060
### Configure a featured MCP server
6161
AI Toolkit provides a list of featured MCP servers that you can use to connect to external APIs and services.
@@ -64,10 +64,10 @@ To configure an MCP server from featured selections, follow these steps:
6464
1. In the **Tools** section, select **+ MCP Server**, and then select **+ Add server** in the Quick Pick.
6565
2. Select **Use Featured MCP Servers** from the dropdown list.
6666
3. Choose an MCP server that meets your needs.
67-
![connect to MCP server](./images/promptbuilder/featured_server_2.png)
67+
![Screenshot showing the connect to MCP server interface in Agent Builder.](./images/promptbuilder/featured-server-2.png)
6868
4. Enter a name for the server.
6969
5. Select tools you want to use.
70-
![select_tools](./images/promptbuilder/select_tools.png)
70+
![Screenshot showing the select tools interface in Agent Builder.](./images/promptbuilder/select-tools.png)
7171

7272
### Use an existing MCP server
7373
> [!TIP]
@@ -82,23 +82,24 @@ To use an existing MCP server, follow these steps:
8282
4. Select tools from the MCP server if there are multiple tools available.
8383
5. Enter your prompts and select **Run** to test the connection.
8484

85-
Here is an example of configuring the [Filesystem](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem) server in AI Toolkit:
85+
Here's an example of configuring the [Filesystem](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem) server in AI Toolkit:
86+
8687
1. In the **Tools** section, select **+ MCP Server**, and then select **+ Add server** in the Quick Pick.
87-
2. Select **Connect to an Existing MCP Server**
88-
3. Select **Command (stdio)**
88+
1. Select **Connect to an Existing MCP Server**
89+
1. Select **Command (stdio)**
8990
> [!NOTE]
9091
> Some servers use the Python runtime and the `uvx` command. The process is the same as using the `npx` command.
91-
4. Navigate to the [Server instructions](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem#npx) and locate the `npx` section.
92-
5. Copy the `command` and `args` into the input box in AI Toolkit. For the Filesystem server example, it will be `npx -y @modelcontextprotocol/server-filesystem /Users/<username>/.aitk/examples`
93-
6. Input a name for the server.
94-
7. Optionally, enter additional environment variables.
95-
Some servers might require additional environment variables such as API keys. In this case, AI Toolkit will fail at the stage of adding tools and a file `mcp.json` will open, where you can enter the required server details following the instructions provided by each server.
96-
![Modify args](./images/promptbuilder/modify_args.png)
97-
Once completed the configuration:
98-
1. Navigate back to **Tools** section and select **+ MCP Server**
99-
2. Select the server you just configured from the dropdown list
100-
3. Select tools you want to use.
101-
8. Select tools you want to use.
92+
1. Navigate to the [Server instructions](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem#npx) and locate the `npx` section.
93+
1. Copy the `command` and `args` into the input box in AI Toolkit. For the Filesystem server example, it's `npx -y @modelcontextprotocol/server-filesystem /Users/<username>/.aitk/examples`
94+
1. Input a name for the server.
95+
1. Optionally, enter extra environment variables.
96+
Some servers might require extra environment variables such as API keys. In this case, AI Toolkit fails at the stage of adding tools and a file `mcp.json` opens, where you can enter the required server details following the instructions provided by each server.
97+
![Screenshot showing an example of a missing arg exception](./images/promptbuilder/modify-args.png)
98+
After you complete the configuration:
99+
1. Navigate back to **Tools** section and select **+ MCP Server**
100+
1. Select the server you configured from the dropdown list
101+
102+
1. Select the tools you want to use.
102103

103104
![connect to MCP server](./images/promptbuilder/mcp_existing.gif)
104105

@@ -107,76 +108,76 @@ AI Toolkit also provides a scaffold to help you build a new MCP server. The scaf
107108
### Build a new MCP server
108109
To build a new MCP server, follow these steps:
109110
1. In the **Tools** section, select **+ MCP Server**, and then select **+ Add server** in the quick pick.
110-
2. Select **Create a New MCP Server**
111-
3. Select a programming language from the dropdown list: **Python** or **TypeScript**
112-
4. Select a folder to create the new MCP server project in.
113-
5. Enter a name for the MCP server project.
111+
1. Select **Create a New MCP Server**
112+
1. Select a programming language from the dropdown list: **Python** or **TypeScript**
113+
1. Select a folder to create the new MCP server project in.
114+
1. Enter a name for the MCP server project.
114115

115-
![scaffold mcp](./images/promptbuilder/scaffold_mcp.gif)
116+
![Animated GIF showing how to use the scaffold mcp](./images/promptbuilder/scaffold-mcp.gif)
116117

117118
After you create the MCP server project, you can customize the implementation to suit your needs. The scaffold includes a basic implementation of the MCP protocol, which you can modify to add your own functionality.
118119

119-
You can also use the agent builder to test the MCP server. The agent builder will send the prompts to the MCP server and display the response.
120+
You can also use the agent builder to test the MCP server. The agent builder sends the prompts to the MCP server and displays the response.
120121

121122
Follow these steps to test the MCP server:
122123

123124
> [!NOTE]
124-
> To run the MCP Server in your local dev machine, you will need: [Node.js](https://nodejs.org/) or Python installed on your machine.
125+
> To run the MCP Server in your local dev machine, you need: [Node.js](https://nodejs.org/) or Python installed on your machine.
125126
126127
1. Open VS Code Debug panel. Select `Debug in Agent Builder` or press `F5` to start debugging the MCP server.
127-
2. Use AI Toolkit Agent Builder to test the server with the following prompt:
128+
1. Use AI Toolkit Agent Builder to test the server with the following prompt:
128129
1. System Prompt: You are a weather forecast professional that can tell weather information based on given location.
129-
3. The server will be automatically connected to Agent Builder.
130-
4. Select `Run` to test the server with the prompt.
130+
1. The server is automatically connected to Agent Builder.
131+
1. Select `Run` to test the server with the prompt.
131132

132-
![debug mcp](./images/promptbuilder/mcp_debug.gif)
133+
![Animated GIF showing the debug mcp process](./images/promptbuilder/mcp-debug.gif)
133134

134135
## Use function calling
135136

136137
Function calling connects your agent to external APIs and services.
137138

138-
![Screenshot showing the Add Custom Function Tool dialog with options to add tools by example or upload schemas.](./images/promptbuilder/add_function_call.png)
139+
![Screenshot showing the Add Custom Function Tool dialog with options to add tools by example or upload schemas.](./images/promptbuilder/add-function-call.png)
139140

140141
1. In **Tools**, select **Add Tool**, then **Custom Tool**.
141-
2. Choose how to add the tool:
142+
1. Choose how to add the tool:
142143
- **By Example**: Add from a JSON schema example
143144
- **Upload Existing Schema**: Upload a JSON schema file
144-
3. Enter the tool name and description, then select **Add**.
145-
4. Provide a mock response in the tool card.
145+
1. Enter the tool name and description, then select **Add**.
146+
1. Provide a mock response in the tool card.
146147

147-
![Screenshot showing a function calling tool card with weather tool configuration.](./images/promptbuilder/function_call_card.png)
148+
![Screenshot showing a function calling tool card with weather tool configuration.](./images/promptbuilder/function-call-card.png)
148149

149-
5. Run the agent with the function calling tool.
150+
1. Run the agent with the function calling tool.
150151

151152
Use function calling tools in the **Evaluation** tab by entering mock responses for test cases.
152153

153-
![Screenshot showing function calling tool usage in the evaluation tab.](./images/promptbuilder/function_call_eval.png)
154+
![Screenshot showing function calling tool usage in the evaluation tab.](./images/promptbuilder/function-call-eval.png)
154155

155156
## Structured output
156157

157158
Structured output support helps you design prompts to deliver outputs in a structured, predictable format.
158159

159-
![Use structured output](./images/promptbuilder/structured_output_2.gif)
160+
![Animated GIF showing how to use structured output](./images/promptbuilder/structured-output-2.gif)
160161

161162
To test using structured output in Agent Builder, follow these steps:
162163

163164
1. Select the **Structure output** from the left area, and select **json_schema**.
164165

165-
2. Select **Prepare schema**, and then select **Select local file** to use your own schema, or select **Use an example** to use a predefined schema.
166+
1. Select **Prepare schema**, and then select **Select local file** to use your own schema, or select **Use an example** to use a predefined schema.
166167

167168
If you proceed with an example, you can select a schema from the dropdown list.
168169

169-
3. Select **Run** to send the prompts to the selected model.
170+
1. Select **Run** to send the prompts to the selected model.
170171

171-
4. You can also edit the schema by selecting name of the schema.
172+
1. You can also edit the schema by selecting name of the schema.
172173

173-
![edit schema](./images/promptbuilder/edit_schema_2.png)
174+
![Screenshot showing the edit schema dropdown in Agent Builder.](./images/promptbuilder/edit-schema-2.png)
174175

175176
## Integrate prompt engineering into your application
176177

177178
After experimenting with models and prompts, you can get into coding right away with the automatically generated Python code.
178179

179-
![view code](./images/promptbuilder/view_code_2.gif)
180+
![Animated GIF showing the generated Python code](./images/promptbuilder/view-code-2.gif)
180181

181182
To view the Python code, follow these steps:
182183

docs/intelligentapps/bulkrun.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
ContentId: 1124d141-e893-4780-aba7-b6ca13628bc5
3-
DateApproved: 06/16/2025
3+
DateApproved: 07/14/2025
44
MetaDescription: Run a set of prompts with variables or function calls with an imported or synthetically generated dataset towards the selected models and parameters.
55
---
66
# Run multiple prompts in bulk
@@ -27,7 +27,7 @@ To start a bulk run in AI Toolkit, follow these steps:
2727
2828
1. Select **Generate Data** to create a synthetic dataset.
2929
1. Choose the number of rows to generate and view or modify the data generation logic.
30-
![Screenshot showing Generate Data dialog in AI Toolkit.](./images/bulkrun/generate_data.png)
30+
![Screenshot showing Generate Data dialog in AI Toolkit.](./images/bulkrun/generate-data.png)
3131
1. Select **Generate** to create the dataset.
3232

3333
> [!TIP]
@@ -37,7 +37,7 @@ To start a bulk run in AI Toolkit, follow these steps:
3737

3838
## Operate on dataset
3939

40-
![Screenshot showing AI Toolkit interface with dataset operations and a table of evaluation results.](./images/bulkrun/dataset_operation.png)
40+
![Screenshot showing AI Toolkit interface with dataset operations and a table of evaluation results.](./images/bulkrun/dataset-operation.png)
4141

4242
AI Toolkit provides several operations to manage and analyze your dataset during a bulk run:
4343

@@ -55,11 +55,11 @@ AI Toolkit provides several operations to manage and analyze your dataset during
5555

5656
AI Toolkit lets you evaluate the results of your bulk run directly in the dataset view.
5757

58-
![Screenshot showing AI Toolkit interface in full screen mode with the Evaluation tab expanded. The dataset table displays multiple columns, including query prompts and AI responses, for detailed analysis.](./images/bulkrun/full_screen.png)
58+
![Screenshot showing AI Toolkit interface in full screen mode with the Evaluation tab expanded. The dataset table displays multiple columns, including query prompts and AI responses, for detailed analysis.](./images/bulkrun/full-screen.png)
5959

6060
You can expand the **Evaluation** tab to full screen mode for a more detailed view of the results. Full screen mode provides the same functionality as the standard view, but with a larger display area for better visibility and analysis.
6161

62-
![Screenshot showing detailed view of evaluation results with a modal dialog displaying a full conversation between user and assistant about weather queries.](./images/bulkrun/view_detail.png)
62+
![Screenshot showing detailed view of evaluation results with a modal dialog displaying a full conversation between user and assistant about weather queries.](./images/bulkrun/view-detail.png)
6363

6464
Select **View Details** to see the full response for each query.
6565

@@ -74,7 +74,7 @@ In the detail view, you can:
7474

7575
## Manage data columns
7676

77-
![Screenshot showing AI Toolkit interface with dataset management options and column management controls.](./images/bulkrun/manage_columns.png)
77+
![Screenshot showing AI Toolkit interface with dataset management options and column management controls.](./images/bulkrun/manage-columns.png)
7878

7979
With data column management, you can customize the dataset view to focus on the most relevant information for your bulk run analysis.
8080

0 commit comments

Comments
 (0)