Skip to content

Commit f70cd7e

Browse files
committed
docs: rework agentic generator getting started
1 parent cfa71a6 commit f70cd7e

File tree

4 files changed

+67
-46
lines changed

4 files changed

+67
-46
lines changed

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

Lines changed: 65 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,49 @@ tag: new
1313

1414
This article describes how to install, configure, and use the Telerik UI for Blazor Agentic UI Generator in Visual Studio and Visual Studio Code.
1515

16-
## Prerequisites
16+
## Quick Start
17+
18+
Follow these steps to set up the Agentic UI Generator:
19+
20+
1. Ensure you have a supported license—You need a DevCraft Complete or Ultimate Subscription to access the Agentic UI Generator. If you have a different license type, you can start a [30-day AI Tools trial](https://www.telerik.com/mcp-servers/thank-you-blazor).
21+
22+
> For more information about access requirements based on the license type, see [Usage Limits](slug:agentic-ui-generator-overview#usage-limits).
23+
1. Add the MCP server to your IDE—Create an `mcp.json` file in your workspace with the following configuration:
24+
````JSON.skip-repl
25+
{
26+
"servers": {
27+
"blazor-ui-generator": {
28+
"type": "http",
29+
"url": "https://uiagent.mcp.telerik.com/mcp/blazor",
30+
"headers": {
31+
"x-api-key": "YOUR API KEY"
32+
}
33+
}
34+
}
35+
}
36+
````
37+
> The server name `blazor-ui-generator` can be customized as desired. The name helps distinguish the MCP server in your configuration and does not affect how you invoke the generator tool in your prompt.
38+
1. Obtain your API key—Log in to your [Telerik account](https://www.telerik.com/account/) and generate an API key from the [API Keys page](https://www.telerik.com/account/downloads/api-keys). Replace `YOUR API KEY` in the `mcp.json` file with the generated key.
39+
1. Start using the generator—Open the AI chat interface of your IDE and start your prompt with the `#telerik_ui_generator` handle to invoke the main generator tool:
40+
````TEXT.skip-repl
41+
#telerik_ui_generator Create a dashboard page with a grid showing sales data and a chart visualizing monthly trends.
42+
````
43+
44+
Step-by-step usage instructions are available in [Using the Agentic UI Generator](#using-the-agentic-ui-generator).
1745
18-
An AI-powered IDE that supports MCP servers, for example, Visual Studio, Visual Studio Code, Cursor.
46+
For comprehensive setup guide specific to your IDE, workspace and global configuration options, and detailed API key instructions, refer to the [Installation](#installation) section below.
1947
2048
## Installation
2149
22-
The Agentic UI Generator is available as an MCP (Model Context Protocol) server that integrates with AI-powered IDEs like Visual Studio Code, Cursor, and other MCP-compatible tools.
50+
Use the documentation of your AI-powered MCP client to add the Agentic UI Generator to a specific workspace or globally. Below you can find installation tips and examples for some popular MCP clients, and instructions for obtaining your API key.
2351
24-
### Configuration Steps
52+
### Visual Studio
2553
26-
This section contains information about how to set up the Agentic UI Generator in Visual Studio and Visual Studio Code.
54+
> This section will guide you through the details of **Step 2** from the [Quick Start](#quick-start).
2755
28-
#### Visual Studio
56+
#### Application Configuration
2957
30-
1. In your browser, 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 2-6 and continue from step 7, instead of creating a new key.
31-
2. Click **Generate New Key +**.
32-
3. In the **Key Note** field, add a note that describes the API key.
33-
4. Click **Generate Key**.
34-
5. 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-
6. Store the generated NuGet API key as you will need it in the next steps.
36-
7. To enable the Agentic UI Generator in your application, in Visual Studio, add a `.mcp.json` file to the solution folder.
37-
8. In the `.mcp.json` file, set your API Key as `x-api-key` value, as demonstrated in the JSON configuration below.
58+
To enable the Agentic UI Generator in your application, in Visual Studio, add a `.mcp.json` file to the solution folder.
3859
3960
>caption .mcp.json
4061
@@ -52,27 +73,29 @@ This section contains information about how to set up the Agentic UI Generator i
5273
}
5374
````
5475

76+
> Replace `YOUR API KEY` with the API key you generate.
77+
78+
The server name `blazor-ui-generator` can be changed to a custom value based on your preferences.
79+
80+
#### Global Configuration
81+
5582
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`.
5683

5784
> Once the MCP server configuration is added, make sure that the `blazor-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 the 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.
5885
59-
#### Visual Studio Code
86+
### Visual Studio Code
6087

61-
1. In your browser, 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 2-6 and continue from step 7, instead of creating a new key.
62-
2. Click **Generate New Key +**.
63-
3. In the **Key Note** field, add a note that describes the API key.
64-
4. Click **Generate Key**.
65-
5. 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.
66-
6. Store the generated NuGet API key as you will need it in the next steps.
67-
7. 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.
88+
> This section will guide you through the details of **Step 2** from the [Quick Start](#quick-start).
6889
69-
> This section applies to VS Code 1.102.1 and newer versions.
90+
For more information about using MCP servers in Visual Studio Code, refer to [Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
7091

7192
Make sure that [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) is enabled in the VS Code settings.
7293

73-
9. In the `mcp.json` file, set your API Key as `x-api-key` value, as demonstrated in the JSON configuration below.
94+
#### Workspace Configuration
7495

75-
>caption .vscode/mcp.json
96+
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.
97+
98+
>caption mcp.json
7699
77100
````JSON.skip-repl
78101
{
@@ -88,6 +111,12 @@ Make sure that [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) is enabl
88111
}
89112
````
90113

114+
> Replace `YOUR API KEY` with the API key you generate.
115+
116+
The server name `blazor-ui-generator` can be changed to a custom value based on your preferences.
117+
118+
#### Global Configuration
119+
91120
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).
92121

93122
>caption VS Code settings.json
@@ -101,33 +130,24 @@ To use the Agentic UI Generator in all workspaces and apps, make sure that [`cha
101130

102131
After adding the configuration, restart your IDE to load the Agentic UI Generator.
103132

104-
## Basic Usage
133+
## Using the Agentic UI Generator
105134

106-
The Agentic UI Generator can be used in two primary modes: basic usage through the main tool, or advanced usage by calling specific MCP tools directly.
135+
> This section will guide you through the details of **Step 4** from the [Quick Start](#quick-start).
107136
108-
### Call the Agentic UI Generator
109-
110-
To use the Agentic UI Generator, you can call it in two ways:
111-
112-
#### Method 1: Using the Tool Handle
113-
114-
Prefix your prompt with `#telerik_ui_generator` followed by your request:
137+
Once installed, start a new chat session in your IDE to begin interacting with the Agentic UI Generator via natural language prompts. The Agentic UI Generator can be used in two primary modes: basic usage through [the main tool](#call-the-agentic-ui-generator), or advanced usage by [calling specific MCP tools directly](#target-the-tools-advanced).
115138

116-
````TEXT.skip-repl
117-
#telerik_ui_generator Create a dashboard page with a grid showing sales data and a chart visualizing monthly trends
118-
````
119-
120-
#### Method 2: Using Natural Language
139+
### Call the Agentic UI Generator
121140

122-
Prefixing your prompt with `#telerik_ui_generator` will make it more likely for the Agentic UI Generator to get called. Alternatively, you can use natural language and simply describe what you want. The AI assistant automatically recognizes when to use the Agentic UI Generator:
141+
1. Open the AI chat interface in your IDE—Start a new chat session to begin interacting with the Agentic UI Generator.
142+
1. In Visual Studio Code, you can start your prompt with the `#telerik_ui_generator` handle—this invokes the main MCP tool that uses an agentic flow to analyze and process your request.
143+
> Using the `#telerik_ui_generator` handle ensures the Agentic UI Generator is called. Alternatively, you can use natural language without the handle. Make sure to mention the "telerik" keyword in your natural language prompt, so that the AI model can automatically recognize when to call the generator. The generator analyzes your prompt and creates the appropriate Blazor components, markup, and styling.
144+
1. Inspect the output and verify that the `blazor-ui-generator` MCP server (or the one with your custom server name) is called. Look for a similar statement in the output:
123145

124-
````TEXT.skip-repl
125-
Create a product management page with a Telerik grid for displaying products, a form for adding new items, and filtering options
126-
````
146+
<img alt="MCP Server uses Telerik UI Generator in VS Code" src="../images/generator-confirmation.png" style="width: 80%"/>
127147

128-
The generator analyzes your prompt and creates the appropriate Blazor components, markup, and styling.
148+
1. If prompted, grant the MCP server permission to run for this session, workspace, or always.
129149

130-
## Advanced Usage
150+
### Target the Tools (Advanced)
131151

132152
For more granular control, you can call individual tools that make up the Agentic UI Generator:
133153

ai/ai-coding-assistant/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The Telerik Blazor AI Conding Assistant allows the following maximum number of r
6464
### Perpetual Licenses
6565

6666
* Perpetual license holders have no access to the AI Coding Assistant by default.
67-
* You can start a [30-day AI Tools trial](https://www.telerik.com/try/agentic-ui-generator) to access the AI Coding Assistant.
67+
* You can start a [30-day AI Tools trial](https://www.telerik.com/mcp-servers/thank-you-blazor) to access the AI Coding Assistant.
6868
* After the trial expires, access is no longer available unless the [Perpetual license is converted to a Subscription license](https://www.telerik.com/account/support-center/contact-us/account-support).
6969

7070
### Trial Licenses
3.51 KB
Loading

components/grid/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The Telerik Blazor Data Grid provides a comprehensive set of ready-to-use featur
1919

2020
The Telerik Blazor grid is built on native Blazor from the ground up, by a company with a long history of making enterprise-ready Grids. This results in a highly customizable Grid that delivers lighting fast performance.
2121

22+
> tip **Jumpstart Your Grid** <br/><br/> With the Agentic UI Generator, you can build components and layouts using natural language prompts — directly inside AI-powered IDEs like VS Code and Cursor. Get intelligent assistance with component implementation, styling, layout design, and iconography powered by our documentation and APIs. <br/><br/>[Try the Agentic UI Generator](slug:agentic-ui-generator-getting-started)
2223
2324
## Creating Blazor Grid
2425

0 commit comments

Comments
 (0)