Skip to content

Commit dccf38b

Browse files
Copilotnenchefdimodi
authored
Document MCP Configuration Features for Visual Studio and VS Code Extensions (#3144)
* Initial plan * Add MCP server and AI configuration documentation for VS and VS Code extensions Co-authored-by: nenchef <3043283+nenchef@users.noreply.github.com> * Polish AI generated content * continued * Update .spelling * Update ai/copilot-extension.md * Update getting-started/vs-code-integration/introduction.md * Update getting-started/vs-integration/introduction.md * Update getting-started/vs-code-integration/introduction.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nenchef <3043283+nenchef@users.noreply.github.com> Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
1 parent 8f1e7a5 commit dccf38b

File tree

9 files changed

+156
-7
lines changed

9 files changed

+156
-7
lines changed

.spelling

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6915,4 +6915,12 @@ k-rpanel-toggle
69156915
- api/javascript/ui/scheduler.md
69166916
workweek
69176917
- third-party/using-kendo-with-data-access.md
6918-
v3
6918+
v3
6919+
MCP
6920+
mcp
6921+
mcp.json
6922+
.mcp.json
6923+
telerikBlazorAssistant
6924+
telerikblazor
6925+
McP
6926+
copilot-instructions.md
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
#number-of-requests
22
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).
33
#end
4+
5+
#vs-intro
6+
provides automated configuration commands for the Telerik AI-powered development tools. These commands help you quickly set up the [Telerik MCP server](slug:ai-mcp-server) and [GitHub Copilot extension](slug:ai-copilot-extension) for enhanced developer productivity with Telerik UI for Blazor components.
7+
#end
8+
9+
#prerequisites
10+
* Check the tool-specific prerequisites for the [Telerik Blazor MCP Server](slug:ai-mcp-server#prerequisites) and the [Telerik Blazor extension for GitHub Copilot](slug:ai-copilot-extension#prerequisites).
11+
#end
12+
13+
#verify-license-key
14+
file to verify that the `TELERIK_LICENSE_PATH` value matches your actual [Telerik license file location](slug:installation-license-key). Alternatively, replace `TELERIK_LICENSE_PATH` with `TELERIK_LICENSE` and set your license key directly. Using `TELERIK_LICENSE_PATH` is recommended.
15+
#end
16+
17+
#command-github-app
18+
command opens the [TelerikBlazor GitHub App installation page](https://github.com/apps/telerikblazor/installations/select_target) in your default browser. Then, follow the [installation instructions for the Telerik Blazor GitHub Copilot Extension](slug:ai-copilot-extension#installation).
19+
#end
20+
21+
#copilot-instructions
22+
command generates a `copilot-instructions.md` file in the `.github` folder under the solution. This file contains custom instructions that help GitHub Copilot provide better assistance when working with Telerik UI for Blazor components. The generated file includes the following default instructions:
23+
24+
* Guidance to use the Telerik MCP Server whenever applicable
25+
* Guidance to prioritize the usage of Telerik UI components
26+
* Guidance to use best coding practices related to Telerik UI for Blazor
27+
#end
28+
29+
#see-also
30+
* [Telerik AI Tooling Overview](slug:ai-overview)
31+
* [Telerik Blazor MCP Server](slug:ai-mcp-server)
32+
* [Telerik Blazor GitHub Copilot Extension](slug:ai-copilot-extension)
33+
#end

ai/copilot-extension.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To use the Telerik GitHub Copilot extension for Blazor, you need to have:
2626

2727
To install the Telerik Blazor Copilot extension:
2828

29-
1. Go to the [TelerikBlazor GitHub App](https://github.com/apps/telerikblazor) page and click the **Install** button.
29+
1. Go to the [TelerikBlazor GitHub App](https://github.com/apps/telerikblazor) page and click the **Install** button. If you have already installed the extension, you will see a **Configure** button instead.
3030
1. You will see a list that includes your GitHub account and all GitHub organizations that you are part of. Normally, select your GitHub account.
3131
1. Click the **Install &amp; Authorize** button. This will authorize the GitHub Copilot extension to integrate with your GitHub account.
3232
1. Enter your GitHub password.
@@ -35,6 +35,8 @@ To install the Telerik Blazor Copilot extension:
3535
1. Restart your [Copilot-enabled apps](https://docs.github.com/en/copilot/building-copilot-extensions/about-building-copilot-extensions#supported-clients-and-ides) (for example, Visual Studio and VS Code).
3636
1. Start a new chat session in Copilot.
3737

38+
You can also start the installation from the Telerik UI for Blazor extensions for [Visual Studio](slug:getting-started-vs-integration-ai-configuration#install-telerik-blazor-copilot-extension) and [VS Code](slug:getting-started-vs-code-integration-ai-configuration). Then, continue the installation from step 2.
39+
3840
## Usage
3941

4042
To use the Telerik Blazor Copilot extension:

ai/mcp-server.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,34 @@ To use the Telerik Blazor MCP server, you need:
2424

2525
## Installation
2626

27-
Use the documentation of your AI-powered MCP client to add the Telerik MCP server to a specific workspace or globally. The sections below provide installation tips and examples for some popular MCP clients like [Visual Studio](#visual-studio), [VS Code](#vs-code), and [Cursor](#cursor). The generic settings of the Telerik Blazor MCP server are:
27+
There are two ways to install the Telerik Blazor MCP server:
28+
29+
* Use a manual approach, which is described below.
30+
* Use an automated process provided by the Telerik extensions for [Visual Studio](slug:getting-started-vs-integration-ai-configuration) and [VS Code](slug:getting-started-vs-code-integration-ai-configuration).
31+
32+
To install the Telerik MCP server manually, use the documentation of your AI-powered MCP client. You can enable the MCP server for specific workspaces or globally. The sections below provide installation tips and examples for some popular MCP clients like [Visual Studio](#visual-studio), [VS Code](#vs-code), and [Cursor](#cursor). The generic settings of the Telerik Blazor MCP server are:
2833

2934
* npm package name: `@progress/telerik-blazor-mcp`
3035
* Type: `stdio` (standard input/output transport)
3136
* Command: `npx`
3237
* Arguments: `-y`
3338
* Server name: `telerikBlazorAssistant` (depends on your preferences)
39+
* Your [Telerik license key](#license-key) as an `env` parameter
3440

3541
> * Do not use hyphens (`-`) or underscores (`_`) in the MCP server name in the MCP `.json` file, due to potential compatibility issues with some MCP clients such as Visual Studio or Windsurf.
3642
> * Some MCP clients expect the MCP servers to be listed under a `servers` JSON key, while others expect `mcpServers`.
3743
> * Some MCP clients expect an `mcp.json` file, while others like Visual Studio 2022 expect an `.mcp.json` file.
3844
39-
You also need to add your [Telerik licence key](slug:installation-license-key) as an `env` parameter in the `mcp.json` file. There are two options:
45+
### License Key
46+
47+
To use the Telerik MCP Server, your configuration must provide your [Telerik licence key](slug:installation-license-key) as an `env` parameter in the MCP `.json` file. There are two options:
4048

4149
* Use a `TELERIK_LICENSE_PATH` argument and point to your Telerik license file location. This approach is recommended, unless you are sharing your VS Code settings across different computers with different operating systems or user names.
4250
* Use a `TELERIK_LICENSE` argument and paste your Telerik license key. Make sure to [update the license key](slug:installation-license-key#license-key-updates) when necessary.
4351

4452
### Visual Studio
4553

46-
For detailed instructions, refer to [Use MCP servers in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers).
54+
For detailed instructions, refer to [Use MCP servers in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers). You can also install the Telerik Blazor MCP server through the [Telerik UI for Blazor Visual Studio extension](slug:getting-started-vs-integration-ai-configuration).
4755

4856
> Early Visual Studio 17.14 versions require the Copilot Chat window to be open and active when you open a solution. Otherwise the Telerik MCP server is not used.
4957
@@ -72,7 +80,7 @@ To enable global automatic discovery of the Telerik MCP Server in Visual Studio,
7280
7381
### VS Code
7482

75-
For detailed instructions, refer to [Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
83+
For detailed instructions, refer to [Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). You can also install the Telerik Blazor MCP server through the [Telerik UI for Blazor VS Code extension](slug:getting-started-vs-code-integration-ai-configuration).
7684

7785
> This section applies to VS Code 1.102.1 and newer versions.
7886
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: AI Tools Configuration
3+
page_title: AI Tools Configuration in VS Code
4+
description: Learn how to configure Telerik AI-powered tools like the MCP server and GitHub Copilot extension for Telerik UI for Blazor development in Visual Studio Code (VS Code).
5+
slug: getting-started-vs-code-integration-ai-configuration
6+
position: 4
7+
---
8+
9+
# AI Tools Configuration in VS Code
10+
11+
The Telerik UI for Blazor Extension for VS Code @[template](/_contentTemplates/common/ai-coding-assistant.md#vs-intro)
12+
13+
## Prerequisites
14+
15+
To set up the Telerik UI for Blazor AI tools automatically:
16+
17+
* [Install the Telerik UI for Blazor extension for VS Code](slug:getting-started-vs-code-integration-overview).
18+
@[template](/_contentTemplates/common/ai-coding-assistant.md#prerequisites)
19+
20+
To access the automated commands:
21+
22+
1. Open the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) at the center top of the VS Code interface.
23+
1. Select **Show and Run Commands**.
24+
1. Search for the following Telerik commands:
25+
* [Configure MCP Server](#configure-mcp-server)
26+
* [Install Telerik Blazor Copilot Extension](#install-telerik-blazor-copilot-extension)
27+
* [Add GitHub Copilot Custom Instructions](#add-github-copilot-custom-instructions)
28+
29+
## Configure MCP Server
30+
31+
The **Telerik UI for Blazor: Configure MCP Server** command provides two configuration scopes to set up the [Telerik Blazor MCP Server](slug:ai-mcp-server#vs-code):
32+
33+
* **Workspace**&mdash;Creates an `mcp.json` file in a `.vscode` folder in your current workspace. This configuration applies only to the current workspace.
34+
* **Global**&mdash;Creates an `mcp.json` file in your operating system user folder (for example, `C:\Users\___\AppData\Roaming\Code\User\.mcp.json` on Windows or `/Users/___/Library/Application Support/Code/User/mcp.json` on macOS). This configuration applies to all VS Code workspaces.
35+
36+
> Make sure to open the generated `mcp.json` @[template](/_contentTemplates/common/ai-coding-assistant.md#verify-license-key)
37+
38+
Finally, check for any [usage notes about the Telerik Blazor MCP Server](slug:ai-mcp-server#vs-code).
39+
40+
## Add GitHub Copilot Custom Instructions
41+
42+
The **Telerik UI for Blazor: Add GitHub Copilot Custom Instructions** @[template](/_contentTemplates/common/ai-coding-assistant.md#copilot-instructions)
43+
44+
## Install Telerik Blazor Copilot Extension
45+
46+
The **Telerik UI for Blazor: Install Telerik Blazor Copilot Extension** @[template](/_contentTemplates/common/ai-coding-assistant.md#command-github-app)
47+
48+
## See Also
49+
50+
@[template](/_contentTemplates/common/ai-coding-assistant.md#see-also)
51+
* [VS Code Integration Overview](slug:getting-started-vs-code-integration-overview)

getting-started/vs-code-integration/introduction.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ The extension for Visual Studio Code provides the following advantages:
2020

2121
* It allows you to [add the Telerik Components to an existing project](slug:getting-started-vs-code-integration-convert-project ) with a few clicks.
2222

23+
* It provides [automated AI tools configuration](slug:getting-started-vs-code-integration-ai-configuration) for the Telerik MCP server and Telerik extension for GitHub Copilot to enhance your development experience with Telerik UI for Blazor.
24+
2325
## Get the Extension
2426

2527
@[template](/_contentTemplates/common/general-info.md#vs-code-x-download)
@@ -30,4 +32,5 @@ To access the VS Code extension, press `Ctrl`+`Shift`+`P` on Windows/Linux or `C
3032

3133
## See Also
3234

35+
* [AI Configuration in VS Code](slug:getting-started-vs-code-integration-ai-configuration)
3336
* [Telerik GitHub Copilot extension for Blazor](slug:ai-copilot-extension)

getting-started/vs-code-integration/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Тroubleshooting
33
page_title: Visual Studio Code Integration Overview
44
description: Learn how to enhance your experience in developing web applications with Progress Telerik UI for Blazor.
55
slug: getting-started-vs-code-integration-troubleshooting
6-
position: 4
6+
position: 10
77
---
88

99
# Troubleshooting
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: AI Tools Configuration
3+
page_title: AI Tools Configuration in Visual Studio
4+
description: Learn how to configure Telerik AI-powered tools like the MCP server and GitHub Copilot extension for Telerik UI for Blazor development in Visual Studio.
5+
slug: getting-started-vs-integration-ai-configuration
6+
position: 8
7+
---
8+
9+
# AI Tools Configuration in Visual Studio
10+
11+
The Telerik UI for Blazor Extension for Visual Studio @[template](/_contentTemplates/common/ai-coding-assistant.md#vs-intro)
12+
13+
## Prerequisites
14+
15+
To set up the Telerik UI for Blazor AI tools automatically:
16+
17+
* [Install the Telerik UI for Blazor extension for Visual Studio](slug:getting-started-vs-integration-overview).
18+
@[template](/_contentTemplates/common/ai-coding-assistant.md#prerequisites)
19+
20+
To access the automated commands, open **Extensions** > **Telerik** > **Telerik UI for Blazor** in the Visual Studio menu.
21+
22+
## Configure Telerik MCP Server
23+
24+
The Telerik UI for Blazor extension provides two menu options to [set up the Telerik Blazor MCP server](slug:ai-mcp-server#visual-studio):
25+
26+
* **Configure MCP Server for Solution**&mdash;this command creates an `.mcp.json` file in the solution folder. The configuration applies only to the projects in that application.
27+
* **Configure MCP Server Globally**&mdash;this command creates an `.mcp.json` file in your operating system user folder (`%USERPROFILE%`, for example, `C:\Users\___\.mcp.json`). This configuration applies to all Visual Studio solutions and projects.
28+
29+
> Make sure to open the generated `.mcp.json` @[template](/_contentTemplates/common/ai-coding-assistant.md#verify-license-key)
30+
31+
Finally, check for any [usage notes about the Telerik Blazor MCP Server](slug:ai-mcp-server#visual-studio).
32+
33+
## Add/Update Copilot Instructions
34+
35+
The **Add/Update Copilot Instructions** @[template](/_contentTemplates/common/ai-coding-assistant.md#copilot-instructions)
36+
37+
## Install Telerik Blazor Copilot Extension
38+
39+
The **Install Telerik Blazor Copilot Extension** @[template](/_contentTemplates/common/ai-coding-assistant.md#command-github-app)
40+
41+
## See Also
42+
43+
@[template](/_contentTemplates/common/ai-coding-assistant.md#see-also)
44+
* [Visual Studio Integration Overview](slug:getting-started-vs-integration-overview)

getting-started/vs-integration/introduction.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ The Telerik UI for Blazor extension for Visual Studio provides the following adv
2424

2525
* It enables you to easily install or update your [Telerik license key](slug:installation-license-key).
2626

27+
* It provides [automated AI tools configuration](slug:getting-started-vs-integration-ai-configuration) for the Telerik MCP server and Telerik extension for GitHub Copilot to enhance your development experience with Telerik UI for Blazor.
28+
2729
The Telerik UI for Blazor VS extension supports Visual Studio 2022 and 2019. @[template](/_contentTemplates/common/general-info.md#vsx-download)
2830

2931
To access the Telerik Visual Studio extension, go to the **Extensions** > **Telerik** > **Telerik UI for Blazor** menu.
@@ -35,4 +37,5 @@ To access the Telerik Visual Studio extension, go to the **Extensions** > **Tele
3537
* [Creating New Projects with Visual Studio](slug:getting-started-vs-integration-new-project)
3638
* [Converting Existing Projects with Visual Studio](slug:getting-started-vs-integration-convert-project)
3739
* [Downloading the Latest Telerik UI for Blazor Versions](slug:getting-started-vs-integration-latest-version)
40+
* [AI Configuration in Visual Studio](slug:getting-started-vs-integration-ai-configuration)
3841
* [Telerik GitHub Copilot extension for Blazor](slug:ai-copilot-extension)

0 commit comments

Comments
 (0)