Skip to content

Commit 07cb106

Browse files
authored
Improve AI Coding Assistant docs (#3197)
* docs(AI): Add usage tips and recommendations * Rename Number of Requests heading * Clarify # usage for VS Code
1 parent 5bc71da commit 07cb106

File tree

4 files changed

+49
-21
lines changed

4 files changed

+49
-21
lines changed

_contentTemplates/common/ai-coding-assistant.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#number-of-requests
2-
A Telerik [Subscription license](https://www.telerik.com/purchase/faq/licensing-purchasing) is recommended in order to use the Telerik Blazor AI Coding Assistant without restrictions. Perpetual license holders and trial users can make a [limited number of requests per year](slug:ai-overview#number-of-requests).
2+
A Telerik [Subscription license](https://www.telerik.com/purchase/faq/licensing-purchasing) is recommended in order to use the Telerik Blazor AI Coding Assistant without restrictions. Perpetual license holders and trial users can make a [limited number of requests per year](slug:ai-overview#usage-limits).
33
#end
44

55
#vs-intro

ai/copilot-extension.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ To use the Telerik GitHub Copilot extension for Blazor, you need to have:
2222
* A [Blazor application that includes Telerik UI for Blazor](slug:blazor-overview#getting-started).
2323
* Using the latest version of your [Copilot-enabled app](https://docs.github.com/en/copilot/building-copilot-extensions/about-building-copilot-extensions#supported-clients-and-ides) is recommended (for example, Visual Studio or VS Code).
2424

25+
Check [AI Coding Assistant Overview](slug:ai-overview) for more recommendations and usage information.
26+
2527
## Installation
2628

2729
To install the Telerik Blazor Copilot extension:
@@ -46,7 +48,8 @@ To use the Telerik Blazor Copilot extension:
4648
1. Start your prompt with `@telerikblazor` and type your request. Make sure that `@telerikblazor` is recognized and highlighted, otherwise the extension may not be installed.
4749
1. Verify that you see a label similar to **TelerikBlazor working...** or **TelerikBlazor generating response...** in the output.
4850
1. Grant permission to the Telerik Blazor extension to read your workspace files.
49-
1. If you want to prompt for information or code that are not related to your previous prompts, it is a good practice to start a new session in a new chat window, so that the context is not polluted by irrelevant old information.
51+
52+
Also check the general [AI Coding Assistant Recommendations](slug:ai-overview#recommendations) for more usage tips.
5053

5154
### Sample Prompts
5255

@@ -56,7 +59,7 @@ The following list describes how your prompts may look like:
5659
* "`@telerikblazor` Generate a Telerik ComboBox for Blazor that shows a list of products. Create a Product class and generate sample data."
5760
* "`@telerikblazor` Show me sample code for a Telerik Blazor Grid with virtual scrolling for the rows and columns."
5861

59-
## Number of Requests
62+
## Usage Limits
6063

6164
@[template](/_contentTemplates/common/ai-coding-assistant.md#number-of-requests)
6265

ai/mcp-server.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ To use the Telerik Blazor MCP server, you need:
2222
* An active [DevCraft or Telerik UI for Blazor license](https://www.telerik.com/purchase/blazor-ui) or a [Telerik UI for Blazor trial](https://www.telerik.com/blazor-ui).
2323
* A [Blazor application that includes Telerik UI for Blazor](slug:blazor-overview#getting-started).
2424

25+
Check [AI Coding Assistant Overview](slug:ai-overview) for more recommendations and usage information.
26+
2527
## Installation
2628

2729
There are two ways to install the Telerik Blazor MCP server:
@@ -141,24 +143,21 @@ To [enable the Telerik MCP Server in a specific workspace, Blazor app, or global
141143

142144
## Usage
143145

146+
By default, MCP clients do not call MCP tools in a deterministic way. Some MCP clients like [VS Code](#vs-code) allow you to explicitly reference the desired MCP tool in your prompt.
147+
144148
To use the Telerik MCP Server:
145149

146-
1. Start your prompt with one of the following:
147-
* `telerik`
148-
* `/telerik`
149-
* `@telerik`
150-
* `telerikblazor`
151-
* `/telerikblazor`
152-
* `@telerikblazor`
153-
1. Confirm that the Telerik MCP server is used, because this doesn't happen deterministically. Look for a statement in the output, which is similar to:
154-
* `Running telerikBlazorAssistant` (in VS Code)
155-
* `Calling MCP tool telerikBlazorAssistant` (in Cursor)
150+
1. Start your prompt with `Telerik` to make it more likely for the Telerik MCP server to get called. If you are using VS Code, then start your prompt with:
151+
* `#` and the MCP server name that you used in `mcp.json` (for example, `#telerikBlazorAssistant`)
152+
* `#` and the name of the Telerik Blazor MCP tool (`#telerik_blazor_assistant`)
153+
1. Confirm that the Telerik MCP server is used. Look for a statement in the output, which is similar to:
154+
* `Running telerik_blazor_assistant` (in VS Code)
155+
* `Calling MCP tool telerik_blazor_assistant` (in Cursor)
156+
1. Grant the Telerik tool permission to run for the current session, workspace, or always.
156157

157-
If the Telerik MCP server is not used even though it's installed and enabled, then try rephrasing your prompt and use another trigger syntax from the list in step 1.
158-
1. Grant the Telerik tool permission to run for this session, workspace, or always.
159-
1. If you want to prompt for information or code that are not related to your previous prompts, it is a good practice to start a new session in a new chat window, so that the context is not polluted by irrelevant old information.
158+
Also check the general [AI Coding Assistant Recommendations](slug:ai-overview#recommendations) for more usage tips.
160159

161-
To increase the probability of the Telerik MCP Server being used, or to call it without the need to mention "telerik" explicitly, add custom instructions to your AI-powered tool. Here are examples for [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot#about-repository-custom-instructions-for-github-copilot-chat) and [Cursor](https://docs.cursor.com/context/rules).
160+
To call the Telerik MCP server without the need to type `Telerik` or `#telerikBlazorAssistant` explicitly, add custom instructions to your AI-powered tool. Here are examples for [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot#about-repository-custom-instructions-for-github-copilot-chat) and [Cursor](https://docs.cursor.com/context/rules).
162161

163162
### Sample Prompts
164163

@@ -168,7 +167,7 @@ The following list describes how your prompts may look like:
168167
* "Telerik Generate a ComboBox for Blazor that shows a list of products. Create a Product class and generate sample data."
169168
* "Telerik Show me sample code for a Blazor Grid with virtual scrolling for the rows and columns."
170169

171-
## Number of Requests
170+
## Usage Limits
172171

173172
@[template](/_contentTemplates/common/ai-coding-assistant.md#number-of-requests)
174173

ai/overview.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,37 @@ To use the Telerik Blazor AI Coding Assistant, you need:
3131
* A [Blazor application that includes Telerik UI for Blazor](slug:blazor-overview#getting-started).
3232
* @[template](/_contentTemplates/common/ai-coding-assistant.md#number-of-requests)
3333

34-
## Number of Requests
34+
## Intended Use
35+
36+
You can use the Telerik AI Coding Assistant for:
37+
38+
* Initial code generation: Quickly add components to your app to speed up the initial development.
39+
* Component configuration: Enable or disable specific component features, or fine tune the configuration through prompting. More complex configurations are possible but may require additional manual work to be production-ready.
40+
* Dummy data generation and data binding: Quickly add data to your app for testing and prototyping purposes. Avoid exposing or providing access to your proprietary or production data to AI-enabled tools.
41+
* Step-by-step explanations: Understand the solutions provided by the AI Coding Assistant through the detailed explanations (depends on the tool, mode, and model). To further develop your knowledge, check the respective documentation.
42+
* Preliminary troubleshooting: Resolve obvious and easy-to-solve issues affecting your code. For more complex issues, search the product documentation or look for assistance from the community.
43+
44+
>warning Always double-check the suggested code and solutions of any AI-powered tool before applying them to your app.
45+
46+
> The Telerik AI Coding Assistant is not intended for styling and theme customization. If you are looking for AI-powered styling and theming, check out [Telerik ThemeBuilder](https://www.telerik.com/themebuilder).
47+
48+
## Recommendations
49+
50+
Consider the following recommendations when working with the Telerik AI Coding Assistant:
51+
52+
* When switching between tasks and files, start a new session in a new chat window to avoid polluting the context with irrelevant or outdated information.
53+
* At the time of publishing, Claude Sonnet 4 and GPT-5 produce better results.
54+
* Sometimes, the AI Coding Assistant might generate custom styles. To avoid any custom styling, include a similar statement in your prompts: `Don't add custom CSS styles`.
55+
56+
## Telerik Document Processing AI Coding Assistant
57+
58+
You can also use the AI Coding Assistant for [Telerik Document Processing](https://www.telerik.com/document-processing-libraries) to generate high-quality code samples and speed up your development. Read the full guide in the dedicated [DPL AI Coding Assistant](https://docs.telerik.com/devtools/document-processing/ai-coding-assistant/overview) article.
59+
60+
## Usage Limits
3561

3662
The Telerik Blazor AI Conding Assistant allows the following maximum number of requests, depending on your [Telerik license type](https://www.telerik.com/purchase/faq/licensing-purchasing):
3763

38-
* Perpetual licenses: 50 requests per year
64+
* Perpetual licenses: include 50 requests per year to let you explore and try out the AI Coding Assistant. If you'd like ongoing, higher-volume access, switch to a Subscription license.
3965
* Subscription licenses: virtually unlimited number of requests with a fair use threshold of 300 requests per day
4066
* Trial licenses: 300 requests per trial per year. Activating the same trial for a new release does not grant additional 300 requests.
4167

@@ -50,7 +76,7 @@ The Telerik Blazor AI Coding Assistant operates under the following conditions:
5076
* The Assistant does not use your prompts to train Telerik AI models.
5177
* The Assistant does not generate the actual responses and has no access to these responses. The Assistant only provides a better context that helps your selected model (for example, GPT, Gemini, Claude) provide better responses.
5278
* The Assistant does not associate your prompts to your Telerik user account. Your prompts and generated context are anonymized and stored for statistical and troubleshooting purposes.
53-
* The Assistant stores metrics about how often and how much you use it in order to ensure compliance with the [allowed number of requests that correspond to your current license](#number-of-requests).
79+
* The Assistant stores metrics about how often and how much you use it in order to ensure compliance with the [allowed number of requests that correspond to your current license](#usage-limits).
5480

5581
Make sure to also get familiar with the terms and privacy policy of your selected AI model and AI client.
5682

0 commit comments

Comments
 (0)