-
Notifications
You must be signed in to change notification settings - Fork 80
Agentic UI generator docs #3334
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
175a7f4
docs: update ai tools structure
IvanDanchev 139b3c5
docs: add generator prompts
IvanDanchev 3709e7a
docs(common): add changelog article for AI assistant
Tsvetomir-Hr 02becd5
chore(common): move changelog article to ai assistant folder
Tsvetomir-Hr f91043d
docs: add ui generator usage note
IvanDanchev d69370f
docs: update ui generator setup steps
IvanDanchev f11e57b
docs: add newest file content
IvanDanchev 99c9062
docs: add pr review suggestions
IvanDanchev 7a15ea7
docs: add pm suggestions
IvanDanchev c62cf3d
docs: add pm suggestions part2
IvanDanchev 5885ef0
docs: add pr review suggestions part3
IvanDanchev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| --- | ||
| title: Getting Started | ||
| page_title: Getting Started with the Telerik UI for Blazor Agentic UI Generator | ||
| description: Learn how to install and configure the Telerik UI for Blazor Agentic UI Generator in Visual Studio and Visual Studio Code. | ||
| slug: agentic-ui-generator-getting-started | ||
| position: 10 | ||
| tags: telerik,blazor,ai,agentic,ui,generator,installation | ||
| published: True | ||
| --- | ||
|
|
||
| # Getting Started with the Agentic UI Generator | ||
|
|
||
| This article describes how to install, configure, and use the Telerik UI for Blazor Agentic UI Generator in Visual Studio and Visual Studio Code. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| An AI-powered IDE that supports MCP servers, for example, Visual Studio, Visual Studio Code, Cursor. | ||
|
|
||
| ## Installation | ||
|
|
||
| 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. | ||
|
|
||
| ### Configuration Steps | ||
|
|
||
| This section contains information about how to set up the Agentic UI Generator in Visual Studio and Visual Studio Code. | ||
|
|
||
| #### Visual Studio | ||
|
|
||
| 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. | ||
| 2. Click **Generate New Key +**. | ||
| 3. In the **Key Note** field, add a note that describes the API key. | ||
| 4. Click **Generate Key**. | ||
| 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. | ||
| 6. Store the generated NuGet API key as you will need it in the next steps. | ||
| 7. To enable the Agentic UI Generator in your application, in Visual Studio, add a `.mcp.json` file to the solution folder. | ||
| 8. In the `.mcp.json` file, set your API Key as `x-api-key` value, as demonstrated in the JSON configuration below. | ||
|
|
||
| >caption .mcp.json | ||
|
|
||
| ````JSON.skip-repl | ||
| { | ||
| "servers": { | ||
| "telerik-ui-generator": { | ||
| "type": "http", | ||
| "url": "https://uiagent.mcp.telerik.com/mcp/blazor", | ||
| "headers": { | ||
| "x-api-key": "YOUR API KEY" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ```` | ||
|
|
||
| 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`. | ||
|
|
||
| > 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 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. | ||
|
|
||
| #### Visual Studio Code | ||
|
|
||
| 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. | ||
| 2. Click **Generate New Key +**. | ||
| 3. In the **Key Note** field, add a note that describes the API key. | ||
| 4. Click **Generate Key**. | ||
| 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. | ||
| 6. Store the generated NuGet API key as you will need it in the next steps. | ||
| 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. | ||
|
|
||
| > This section applies to VS Code 1.102.1 and newer versions. | ||
|
|
||
| Make sure that [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) is enabled in the VS Code settings. | ||
|
|
||
| 9. In the `mcp.json` file, set your API Key as `x-api-key` value, as demonstrated in the JSON configuration below. | ||
|
|
||
| >caption .vscode/mcp.json | ||
|
|
||
| ````JSON.skip-repl | ||
| { | ||
| "servers": { | ||
| "telerik-ui-generator": { | ||
| "type": "http", | ||
| "url": "https://uiagent.mcp.telerik.com/mcp/blazor", | ||
| "headers": { | ||
| "x-api-key": "YOUR API KEY" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ```` | ||
|
|
||
| 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). | ||
|
|
||
| >caption VS Code settings.json | ||
|
|
||
| ````JSON.skip-repl | ||
| { | ||
| // ... | ||
| "chat.mcp.discovery.enabled": true, | ||
| } | ||
| ```` | ||
|
|
||
| After adding the configuration, restart your IDE to load the Agentic UI Generator. | ||
|
|
||
| ## Basic Usage | ||
|
|
||
| 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. | ||
|
|
||
| ### Call the Agentic UI Generator | ||
|
|
||
| To use the Agentic UI Generator, you can call it in two ways: | ||
|
|
||
| #### Method 1: Using the Tool Handle | ||
|
|
||
| Prefix your prompt with `#telerik_ui_generator` followed by your request: | ||
|
|
||
| ````TEXT.skip-repl | ||
| #telerik_ui_generator Create a dashboard page with a grid showing sales data and a chart visualizing monthly trends | ||
| ```` | ||
|
|
||
| #### Method 2: Using Natural Language | ||
|
|
||
| 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: | ||
|
|
||
| ````TEXT.skip-repl | ||
| Create a product management page with a Telerik grid for displaying products, a form for adding new items, and filtering options | ||
| ```` | ||
|
|
||
| The generator analyzes your prompt and creates the appropriate Blazor components, markup, and styling. | ||
|
|
||
| ## Advanced Usage | ||
|
|
||
| For more granular control, you can call individual tools that make up the Agentic UI Generator: | ||
|
|
||
| | Tool Handle | Description | | ||
| |------------|-------------| | ||
| | `telerik_ui_generator` | Main generator for building full UI flows. Coordinates all other tools to deliver complete solutions. | | ||
| | `telerik_layout_assistant` | Applies suitable CSS utility classes from the Progress Design System for styling and positioning elements. Use this tool when you need help with spacing, typography, colors, layout structure, or transforms. | | ||
| | `telerik_component_assistant` | Answers questions and generates code related to Telerik UI for Blazor components. Use this tool when you need to implement or configure specific UI for Blazor components like Grid, Charts, Forms, etc. | | ||
| | `telerik_style_assistant` | Generates custom styles and theme configurations for your application. Use this tool when you need to apply brand-specific colors, create custom themes, or modify the overall visual design of your UI. | | ||
| | `telerik_icon_assistant` | Searches and retrieves icons from the Progress Design System iconography by name, category, or keywords. Use this tool when you need to find and add specific icons for your UI components or design elements. | | ||
|
|
||
| You can call these tools directly when you need specific functionality, allowing for more precise control over the generation process. | ||
|
|
||
| > 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. | ||
|
|
||
| ## See Also | ||
|
|
||
| * [Agentic UI Generator Overview](slug:agentic-ui-generator-overview) | ||
| * [Agentic UI Generator Prompt Library](slug:agentic-ui-generator-prompt-library) | ||
| * [Telerik Design System](https://www.telerik.com/design-system/docs/) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.