You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/intelligentapps/agentbuilder.md
+50-49Lines changed: 50 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
2
ContentId: bd3d7555-3d84-4500-ae95-6dcd39641af0
3
-
DateApproved: 06/16/2025
3
+
DateApproved: 07/14/2025
4
4
MetaDescription: Get Started with creating, iterating and optimizing your agents in AI Toolkit.
5
5
---
6
6
# Build agents and prompts in AI Toolkit
7
7
8
8
> [!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.
10
10
11
11
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:
12
12
- Generate starter prompts
@@ -25,22 +25,22 @@ Agent Builder also enhances intelligent app's capabilities with tool use:
25
25
26
26
To access Agent Builder, use either of these options:
27
27
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
30
30
31
31
To test a prompt in Agent Builder, follow these steps:
32
32
33
33
1. In **Models**, select a model from the dropdown list, or select **Browse models** to add another model from the model catalog.
34
34
35
-

35
+

36
36
37
37
1. Enter a **User prompt** and optionally enter a **System prompt**.
38
38
39
39
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.
40
40
41
41
> [!TIP]
42
42
> Describe your project idea using natural language to generate prompts automatically.
43
-
> 
43
+
> 
44
44
45
45
3. Select **Run** to send the prompts to the model.
46
46
@@ -51,11 +51,11 @@ To test a prompt in Agent Builder, follow these steps:
51
51
## Use MCP servers
52
52
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.
53
53
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.
55
55
56
56
> [!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/)
59
59
60
60
### Configure a featured MCP server
61
61
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:
64
64
1. In the **Tools** section, select **+ MCP Server**, and then select **+ Add server** in the Quick Pick.
65
65
2. Select **Use Featured MCP Servers** from the dropdown list.
66
66
3. Choose an MCP server that meets your needs.
67
-

67
+


71
71
72
72
### Use an existing MCP server
73
73
> [!TIP]
@@ -82,23 +82,24 @@ To use an existing MCP server, follow these steps:
82
82
4. Select tools from the MCP server if there are multiple tools available.
83
83
5. Enter your prompts and select **Run** to test the connection.
84
84
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
+
86
87
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)**
89
90
> [!NOTE]
90
91
> 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.
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
+

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.
102
103
103
104

104
105
@@ -107,76 +108,76 @@ AI Toolkit also provides a scaffold to help you build a new MCP server. The scaf
107
108
### Build a new MCP server
108
109
To build a new MCP server, follow these steps:
109
110
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.

116
117
117
118
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.
118
119
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.
120
121
121
122
Follow these steps to test the MCP server:
122
123
123
124
> [!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.
125
126
126
127
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:
128
129
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.

133
134
134
135
## Use function calling
135
136
136
137
Function calling connects your agent to external APIs and services.
137
138
138
-

139
+

139
140
140
141
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:
142
143
-**By Example**: Add from a JSON schema example
143
144
-**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.
146
147
147
-

148
+

148
149
149
-
5. Run the agent with the function calling tool.
150
+
1. Run the agent with the function calling tool.
150
151
151
152
Use function calling tools in the **Evaluation** tab by entering mock responses for test cases.
152
153
153
-

154
+

154
155
155
156
## Structured output
156
157
157
158
Structured output support helps you design prompts to deliver outputs in a structured, predictable format.
Copy file name to clipboardExpand all lines: docs/intelligentapps/bulkrun.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
ContentId: 1124d141-e893-4780-aba7-b6ca13628bc5
3
-
DateApproved: 06/16/2025
3
+
DateApproved: 07/14/2025
4
4
MetaDescription: Run a set of prompts with variables or function calls with an imported or synthetically generated dataset towards the selected models and parameters.
5
5
---
6
6
# Run multiple prompts in bulk
@@ -27,7 +27,7 @@ To start a bulk run in AI Toolkit, follow these steps:
27
27
28
28
1. Select **Generate Data** to create a synthetic dataset.
29
29
1. Choose the number of rows to generate and view or modify the data generation logic.
30
-

30
+

31
31
1. Select **Generate** to create the dataset.
32
32
33
33
> [!TIP]
@@ -37,7 +37,7 @@ To start a bulk run in AI Toolkit, follow these steps:
37
37
38
38
## Operate on dataset
39
39
40
-

40
+

41
41
42
42
AI Toolkit provides several operations to manage and analyze your dataset during a bulk run:
43
43
@@ -55,11 +55,11 @@ AI Toolkit provides several operations to manage and analyze your dataset during
55
55
56
56
AI Toolkit lets you evaluate the results of your bulk run directly in the dataset view.
57
57
58
-

58
+

59
59
60
60
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.
61
61
62
-

62
+

63
63
64
64
Select **View Details** to see the full response for each query.
65
65
@@ -74,7 +74,7 @@ In the detail view, you can:
74
74
75
75
## Manage data columns
76
76
77
-

77
+

78
78
79
79
With data column management, you can customize the dataset view to focus on the most relevant information for your bulk run analysis.
0 commit comments