Skip to content

Commit ccd5ddf

Browse files
authored
docs: update docs for hot fix (#8320)
* docs: update docs for hot fix * minor fix on syntax * docs: improve clarity and consistency in MCP server usage instructions
1 parent d0a8a70 commit ccd5ddf

File tree

4 files changed

+34
-14
lines changed

4 files changed

+34
-14
lines changed

docs/intelligentapps/agentbuilder.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,22 +63,15 @@ To configure an MCP server from featured selections, follow these steps:
6363
1. In the **Tools** section, select **+ MCP Server**, and then select **+ Add server** in the Quick Pick.
6464
2. Select **Use Featured MCP Servers** from the dropdown list.
6565
3. Choose an MCP server that meets your needs.
66-
![connect to MCP server](./images/promptbuilder/Featured_server.png)
67-
68-
For servers that are ready to use, AI Toolkit will prompt you to select tools and add to your agent afterwards.
69-
70-
For servers that are marked with **(Configuration Required)**:
71-
1. You will be prompted to enter the required configurations in the `mcp.json` file.
72-
![config_server](./images/promptbuilder/config_server.png)
73-
2. Follow the guidelines to configure the server:
74-
1. [Filesystem](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem#npx)
75-
2. [GitHub](https://github.com/modelcontextprotocol/servers/tree/main/src/github#npx)
76-
3. [Google Maps](https://github.com/modelcontextprotocol/servers/tree/main/src/google-maps#npx)
77-
4. [Sqlite](https://github.com/modelcontextprotocol/servers/tree/main/src/sqlite#uv-1)
78-
3. After finishing the configuration, go back to Agent Builder and select **+ MCP Server** to locate the server you added from the list.
79-
4. Select the server and proceed to add tools.
66+
![connect to MCP server](./images/promptbuilder/featured_server_2.png)
67+
4. Enter a name for the server.
68+
5. Select tools you want to use.
69+
![select_tools](./images/promptbuilder/select_tools.png)
8070

8171
### Use an existing MCP server
72+
> [!TIP]
73+
> There are many registries and marketplaces for MCP servers. We recommend starting with these [reference servers](https://github.com/modelcontextprotocol/servers?tab=readme-ov-file#-reference-servers).
74+
8275
To use an existing MCP server, follow these steps:
8376
1. In the **Tools** section, select **+ MCP Server**, and then select **+ Add server** in the quick pick.
8477
2. Select **Connect to an Existing MCP Server**
@@ -88,6 +81,24 @@ To use an existing MCP server, follow these steps:
8881
4. Select tools from the MCP server if there are multiple tools available.
8982
5. Enter your prompts and select **Run** to test the connection.
9083

84+
Here is an example of configuring the [Filesystem](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem) server in AI Toolkit:
85+
1. In the **Tools** section, select **+ MCP Server**, and then select **+ Add server** in the Quick Pick.
86+
2. Select **Connect to an Existing MCP Server**
87+
3. Select **Command (stdio)**
88+
> [!NOTE]
89+
> Some servers use the Python runtime and the `uvx` command. The process is the same as using the `npx` command.
90+
4. Navigate to the [Server instructions](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem#npx) and locate the `npx` section.
91+
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`
92+
6. Input a name for the server.
93+
7. Optionally, enter additional environment variables.
94+
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.
95+
![Modify args](./images/promptbuilder/modify_args.png)
96+
Once completed the configuration:
97+
1. Navigate back to **Tools** section and select **+ MCP Server**
98+
2. Select the server you just configured from the dropdown list
99+
3. Select tools you want to use.
100+
8. Select tools you want to use.
101+
91102
![connect to MCP server](./images/promptbuilder/mcp_existing.gif)
92103

93104
AI Toolkit also provides a scaffold to help you build a new MCP server. The scaffold includes a basic implementation of the MCP protocol, which you can customize to suit your needs.
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)