Skip to content

Commit 569cf8f

Browse files
Copilotnenchef
andcommitted
Add MCP server and AI configuration documentation for VS and VS Code extensions
Co-authored-by: nenchef <[email protected]>
1 parent f0a0eb4 commit 569cf8f

File tree

7 files changed

+209
-2
lines changed

7 files changed

+209
-2
lines changed

.spelling

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6915,4 +6915,11 @@ k-rpanel-toggle
69156915
- api/javascript/ui/scheduler.md
69166916
workweek
69176917
- third-party/using-kendo-with-data-access.md
6918-
v3
6918+
v3MCP
6919+
mcp
6920+
mcp.json
6921+
.mcp.json
6922+
telerikBlazorAssistant
6923+
telerikblazor
6924+
McP
6925+
copilot-instructions.md

ai/copilot-extension.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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 use the automated installation commands 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) to quickly open the installation page.
39+
3840
## Usage
3941

4042
To use the Telerik Blazor Copilot extension:

ai/mcp-server.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,18 @@ 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+
You can install the Telerik Blazor MCP server manually or use automated configuration commands 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).
28+
29+
### Automated Installation
30+
31+
The easiest way to configure the Telerik Blazor MCP server is through the automated commands in the Telerik extensions:
32+
33+
* **Visual Studio**: Use the "Configure MCP Server for Solution" or "Configure MCP Server Globally" commands. For details, see [AI Configuration in Visual Studio](slug:getting-started-vs-integration-ai-configuration).
34+
* **VS Code**: Use the "Telerik UI for Blazor: Configure MCP Server" command. For details, see [AI Configuration in VS Code](slug:getting-started-vs-code-integration-ai-configuration).
35+
36+
### Manual Installation
37+
38+
For manual installation or when using other MCP clients, 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:
2839

2940
* npm package name: `@progress/telerik-blazor-mcp`
3041
* Type: `stdio` (standard input/output transport)
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: AI Configuration
3+
page_title: Visual Studio Code AI Configuration
4+
description: Learn how to configure AI-powered tools like MCP servers and GitHub Copilot for Telerik UI for Blazor development in Visual Studio Code.
5+
slug: getting-started-vs-code-integration-ai-configuration
6+
position: 8
7+
---
8+
9+
# AI Configuration in Visual Studio Code
10+
11+
The Telerik UI for Blazor Extension for Visual Studio Code provides automated configuration commands for AI-powered development tools. These commands help you quickly set up [MCP servers](slug:ai-mcp-server) and [GitHub Copilot](slug:ai-copilot-extension) for enhanced developer productivity with Telerik UI for Blazor components.
12+
13+
## Available Commands
14+
15+
To access these commands, press `Ctrl`+`Shift`+`P` on Windows/Linux or `Cmd`+`Shift`+`P` on Mac to open the VS Code command palette, then search for the following Telerik commands:
16+
17+
### Configure MCP Server
18+
19+
The **Telerik UI for Blazor: Configure MCP Server** command automatically creates the necessary configuration file for the [Telerik Blazor MCP Server](slug:ai-mcp-server). This command provides two configuration scopes:
20+
21+
* **Workspace Scope** - Creates an `mcp.json` file under the `.vscode` folder in your current workspace. This configuration applies only to the current workspace.
22+
* **Global Scope** - Creates an `mcp.json` file under `C:\Users\[username]\AppData\Roaming\Code\User\` (Windows) or the equivalent user configuration directory on other platforms. This configuration applies to all VS Code workspaces.
23+
24+
The generated `mcp.json` file includes the proper configuration for the Telerik Blazor MCP server with placeholder values for your Telerik license. You need to update the license path or key in the generated file.
25+
26+
>caption Generated .vscode/mcp.json (Workspace Scope)
27+
28+
```json
29+
{
30+
"servers": {
31+
"telerikBlazorAssistant": {
32+
"type": "stdio",
33+
"command": "npx",
34+
"args": ["-y", "@progress/telerik-blazor-mcp@latest"],
35+
"env": {
36+
"TELERIK_LICENSE_PATH": "C:\\Users\\___\\AppData\\Roaming\\Telerik\\telerik-license.txt"
37+
}
38+
}
39+
}
40+
}
41+
```
42+
43+
> Make sure to update the `TELERIK_LICENSE_PATH` value with your actual [Telerik license file location](slug:installation-license-key), or replace it with a `TELERIK_LICENSE` key containing your license key directly.
44+
45+
### Add GitHub Copilot Custom Instructions
46+
47+
The **Telerik UI for Blazor: Add GitHub Copilot Custom Instructions** command generates a `copilot-instructions.md` file under the `.github` folder in your current workspace. This file contains custom instructions that help GitHub Copilot provide better assistance when working with Telerik UI for Blazor components.
48+
49+
The generated file includes:
50+
* Best practices for Razor component development
51+
* Telerik UI for Blazor specific coding guidelines
52+
* Component naming conventions
53+
* Recommended code structure patterns
54+
55+
### Install Telerik Blazor Copilot Extension
56+
57+
The **Telerik UI for Blazor: Install Telerik Blazor Copilot Extension** command opens the GitHub App installation page in your default browser:
58+
59+
`https://github.com/apps/telerikblazor/installations/select_target`
60+
61+
This allows you to quickly install the [Telerik Blazor GitHub Copilot Extension](slug:ai-copilot-extension) for your GitHub account or organization.
62+
63+
## Prerequisites
64+
65+
Before using these AI configuration commands, ensure you have:
66+
67+
* A [Telerik user account](https://www.telerik.com/account/)
68+
* An active [DevCraft or Telerik UI for Blazor license](https://www.telerik.com/purchase/blazor-ui) or [trial](https://www.telerik.com/blazor-ui)
69+
* [Node.js](https://nodejs.org/en) 18 or newer (for MCP server functionality)
70+
* The latest version of the Telerik UI for Blazor VS Code extension
71+
72+
## Next Steps
73+
74+
After configuring the AI tools:
75+
76+
1. **For MCP Server**: Follow the [complete MCP server setup guide](slug:ai-mcp-server) to understand usage and troubleshooting.
77+
2. **For GitHub Copilot**: Learn how to use the [Telerik Blazor Copilot Extension](slug:ai-copilot-extension) effectively.
78+
3. **For both**: Review the [AI tooling overview](slug:ai-overview) to understand the capabilities and limitations of these tools.
79+
80+
## See Also
81+
82+
* [Telerik Blazor MCP Server](slug:ai-mcp-server)
83+
* [Telerik Blazor GitHub Copilot Extension](slug:ai-copilot-extension)
84+
* [AI Tooling Overview](slug:ai-overview)
85+
* [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 configuration](slug:getting-started-vs-code-integration-ai-configuration) for MCP servers and 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)
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: AI Configuration
3+
page_title: Visual Studio AI Configuration
4+
description: Learn how to configure AI-powered tools like MCP servers and GitHub Copilot for Telerik UI for Blazor development in Visual Studio.
5+
slug: getting-started-vs-integration-ai-configuration
6+
position: 8
7+
---
8+
9+
# AI Configuration in Visual Studio
10+
11+
The Telerik UI for Blazor Extension for Visual Studio provides automated configuration commands for AI-powered development tools. These commands help you quickly set up [MCP servers](slug:ai-mcp-server) and [GitHub Copilot](slug:ai-copilot-extension) for enhanced developer productivity with Telerik UI for Blazor components.
12+
13+
## Available Commands
14+
15+
To access these commands, go to **Extensions** > **Telerik** > **Telerik UI for Blazor** in the Visual Studio menu.
16+
17+
### Configure MCP Server
18+
19+
The Telerik UI for Blazor extension provides two MCP server configuration options:
20+
21+
#### Configure MCP Server for Solution
22+
23+
The **Configure MCP Server for Solution** command generates a `.mcp.json` file in the solution folder. This configuration applies only to the current solution and any projects within it.
24+
25+
#### Configure MCP Server Globally
26+
27+
The **Configure MCP Server Globally** command generates a `.mcp.json` file under the user profile directory (`%USERPROFILE%`, for example, `C:\Users\<yourusername>`). This configuration applies to all Visual Studio solutions and projects.
28+
29+
Both commands create a properly configured `.mcp.json` file for the [Telerik Blazor MCP Server](slug:ai-mcp-server) with placeholder values for your Telerik license.
30+
31+
>caption Generated .mcp.json
32+
33+
```json
34+
{
35+
"servers": {
36+
"telerikBlazorAssistant": {
37+
"type": "stdio",
38+
"command": "npx",
39+
"args": ["-y", "@progress/telerik-blazor-mcp@latest"],
40+
"env": {
41+
"TELERIK_LICENSE_PATH": "C:\\Users\\___\\AppData\\Roaming\\Telerik\\telerik-license.txt"
42+
}
43+
}
44+
}
45+
}
46+
```
47+
48+
> Make sure to update the `TELERIK_LICENSE_PATH` value with your actual [Telerik license file location](slug:installation-license-key), or replace it with a `TELERIK_LICENSE` key containing your license key directly.
49+
50+
### Add/Update Copilot Instructions
51+
52+
The **Add/Update Copilot Instructions** 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.
53+
54+
The generated file includes:
55+
* Best practices for Razor component development
56+
* Telerik UI for Blazor specific coding guidelines
57+
* Component naming conventions
58+
* Recommended code structure patterns
59+
60+
### Install Telerik Blazor Copilot Extension
61+
62+
The **Install Telerik Blazor Copilot Extension** command opens the GitHub App installation page in your default browser:
63+
64+
`https://github.com/apps/telerikblazor/installations/select_target`
65+
66+
This allows you to quickly install the [Telerik Blazor GitHub Copilot Extension](slug:ai-copilot-extension) for your GitHub account or organization.
67+
68+
## Prerequisites
69+
70+
Before using these AI configuration commands, ensure you have:
71+
72+
* A [Telerik user account](https://www.telerik.com/account/)
73+
* An active [DevCraft or Telerik UI for Blazor license](https://www.telerik.com/purchase/blazor-ui) or [trial](https://www.telerik.com/blazor-ui)
74+
* [Node.js](https://nodejs.org/en) 18 or newer (for MCP server functionality)
75+
* Visual Studio 2022 or 2019 with the latest Telerik UI for Blazor extension
76+
77+
## Important Notes for Visual Studio
78+
79+
* Early Visual Studio 17.14 versions require the Copilot Chat window to be open and active when you open a solution for the MCP server to work properly.
80+
* After configuring the MCP server, make sure that the `telerikBlazorAssistant` 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).
81+
* The Telerik MCP server may get disabled and you may see "🔧10/11" in the selected tools dropdown when starting a new chat, changing threads, or relaunching Visual Studio. This is a known issue that is being investigated.
82+
83+
## Next Steps
84+
85+
After configuring the AI tools:
86+
87+
1. **For MCP Server**: Follow the [complete MCP server setup guide](slug:ai-mcp-server) to understand usage and troubleshooting.
88+
2. **For GitHub Copilot**: Learn how to use the [Telerik Blazor Copilot Extension](slug:ai-copilot-extension) effectively.
89+
3. **For both**: Review the [AI tooling overview](slug:ai-overview) to understand the capabilities and limitations of these tools.
90+
91+
## See Also
92+
93+
* [Telerik Blazor MCP Server](slug:ai-mcp-server)
94+
* [Telerik Blazor GitHub Copilot Extension](slug:ai-copilot-extension)
95+
* [AI Tooling Overview](slug:ai-overview)
96+
* [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 configuration](slug:getting-started-vs-integration-ai-configuration) for MCP servers and 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)