Skip to content

Commit d69370f

Browse files
committed
docs: update ui generator setup steps
1 parent f91043d commit d69370f

File tree

1 file changed

+69
-5
lines changed

1 file changed

+69
-5
lines changed

ai/agentic-ui-generator/getting-started.md

Lines changed: 69 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,80 @@ This section contains information about how to set up the Agentic UI Generator i
2727
#### Visual Studio
2828

2929
1. Log in with a valid [Telerik user account](https://www.telerik.com/account/).
30-
2. To enable the Agentic UI Generator in a specific Blazor app, add a `.mcp.json` file to the solution folder and paste the configuration from the [Agentic UI Generator | MCP Configuration page](https://uiagent.mcp.telerik.com/preview).
30+
2. Go to the [API Keys](https://www.telerik.com/account/downloads/api-keys) page in your Telerik account. If you already have an existing API key, you can skip steps 3-7 and continue from step 8, instead of creating a new key.
31+
3. Click **Generate New Key +**.
32+
4. In the **Key Note** field, add a note that describes the API key.
33+
5. Click **Generate Key**.
34+
6. Select **Copy and Close**. Once you close the window, you can no longer copy the generated key. For security reasons, the **API Keys** page displays only a portion of the key.
35+
7. Store the generated NuGet API key as you will need it in the next steps.
36+
8. To enable the Agentic UI Generator in a specific Blazor app, add a `.mcp.json` file to the solution folder.
37+
9. In the `.mcp.json` file, set your API Key as `x-api-key` value, as demonstrated in the JSON configuration below.
38+
39+
>caption .mcp.json
40+
41+
````JSON.skip-repl
42+
{
43+
"servers": {
44+
"telerik-ui-generator": {
45+
"type": "http",
46+
"url": "https://uiagent.mcp.telerik.com/mcp/blazor",
47+
"headers": {
48+
"x-api-key": "YOUR API KEY"
49+
}
50+
}
51+
}
52+
}
53+
````
3154

3255
To enable global automatic discovery of the Agentic UI Generator in Visual Studio, add the above `.mcp.json` file to your user directory (`%USERPROFILE%`), for example, `C:\Users\____\.mcp.json`.
3356

57+
> Once the MCP server configuration is added, make sure that the `telerik-ui-generator` tool is [enabled (checked) in the Copilot Chat window's tool selection dropdown](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022#configuration-example-with-github-mcp-server). This dropdown opens when clicking on a wrench icon 🔧 at the bottom of the Copilot Window. The Telerik Agentic UI Generator may get disabled when starting a new chat, changing threads, or relaunching Visual Studio. This is a known issue with MCP servers in general.
58+
3459
#### Visual Studio Code
3560

3661
1. Log in with a valid [Telerik user account](https://www.telerik.com/account/).
37-
2. Go to the [Agentic UI Generator Preview Configuration](https://uiagent.mcp.telerik.com/preview).
38-
3. Click the **Add to VS Code** button. This will open a tab named **MCP Server: telerik-ui-generator** in your VS Code instance.
39-
4. In the new VS Code tab, click **Install**.
62+
2. Go to the [API Keys](https://www.telerik.com/account/downloads/api-keys) page in your Telerik account. If you already have an existing API key, you can skip steps 3-7 and continue from step 8, instead of creating a new key.
63+
3. Click **Generate New Key +**.
64+
4. In the **Key Note** field, add a note that describes the API key.
65+
5. Click **Generate Key**.
66+
6. Select **Copy and Close**. Once you close the window, you can no longer copy the generated key. For security reasons, the **API Keys** page displays only a portion of the key.
67+
7. Store the generated NuGet API key as you will need it in the next steps.
68+
8. To enable the Agentic UI Generator in a specific [workspace](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server-to-your-workspace), Blazor app, or [globally](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server-to-your-user-configuration), add a `.vscode` folder with an `mcp.json` file at the root of the workspace, app, or your user folder, respectively.
69+
70+
> This section applies to VS Code 1.102.1 and newer versions.
71+
72+
Make sure that [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) is enabled in the VS Code settings.
73+
74+
9. In the `mcp.json` file, set your API Key as `x-api-key` value, as demonstrated in the JSON configuration below.
75+
76+
>caption .vscode/mcp.json
77+
78+
````JSON.skip-repl
79+
{
80+
"servers": {
81+
"telerik-ui-generator": {
82+
"type": "http",
83+
"url": "https://uiagent.mcp.telerik.com/mcp/blazor",
84+
"headers": {
85+
"x-api-key": "YOUR API KEY"
86+
}
87+
}
88+
}
89+
}
90+
````
91+
92+
To use the Agentic UI Generator in all workspaces and apps, make sure that [`chat.mcp.discovery.enabled`](vscode://settings/chat.mcp.discovery.enabled) is enabled in [`settings.json`](https://code.visualstudio.com/docs/configure/settings#_settings-json-file).
4093

41-
After adding the configuration, restart your IDE to load the MCP server.
94+
>caption VS Code settings.json
95+
96+
````JSON.skip-repl
97+
{
98+
// ...
99+
"chat.mcp.discovery.enabled": true,
100+
}
101+
````
102+
103+
After adding the configuration, restart your IDE to load the Agentic UI Generator.
42104

43105
## Basic Usage
44106

@@ -80,6 +142,8 @@ For more granular control, you can call individual tools that make up the Agenti
80142

81143
You can call these tools directly when you need specific functionality, allowing for more precise control over the generation process.
82144

145+
> Tagging specific tools in Visual Studio currently is not available. To increase the probability that a tool will be called, either explicitly mention the tool in your prompt, or specify that in your Copilot instructions.
146+
83147
## See Also
84148

85149
* [Agentic UI Generator Overview](slug:agentic-ui-generator-overview)

0 commit comments

Comments
 (0)