Skip to content

Commit b09b3d6

Browse files
didiyordanovadidiyordanova
authored
Merge pull request #1277 from telerik/add-mcp-server-nuget-distribution-info
Add AI Assistant MCP Server NuGet Distribution Info
2 parents c903011 + f9cd7e2 commit b09b3d6

File tree

1 file changed

+176
-95
lines changed

1 file changed

+176
-95
lines changed

‎ai/mcp-server.md‎

Lines changed: 176 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -7,145 +7,223 @@ tags: telerik,maui,ai,ai server,dotnetmaui,coding assistant
77
position: 1
88
---
99

10-
# Telerik .NET MAUI MCP Server
10+
# Telerik UI for .NET MAUI MCP Server
1111

12-
The Telerik MAUI [MCP (Model Context Protocol) Server](https://modelcontextprotocol.io/introduction) enhances your AI-powered development experience by providing specialized context about Telerik UI for .NET MAUI components.
12+
The Telerik MAUI [MCP (Model Context Protocol) server](https://modelcontextprotocol.io/introduction) enhances your AI-powered development experience by providing specialized context about Telerik UI for .NET MAUI components.
1313

1414
This MCP server enables AI-powered IDEs and tools to generate more accurate, tailored code that leverages [Telerik UI for .NET MAUI components](https://www.telerik.com/maui-ui) and APIs. You can ask complex questions about Telerik components, request specific implementations, and generate comprehensive code solutions.
1515

16-
>tip The Telerik .NET MAUI MCP Server works in **Chat**(**Ask**) and **Agent** modes.
16+
>tip The Telerik MAUI MCP server works in **Chat** (**Ask**) and **Agent** modes.
1717
1818

1919
## Prerequisites
2020

2121
To use the Telerik MAUI MCP server, you need:
2222

23-
* [Node.js](https://nodejs.org/en) 18 or newer.
24-
* An [MCP-compatible client](https://modelcontextprotocol.io/clients) that supports **MCP tools** (latest version recommended).
23+
* [.NET](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-8/overview) 9 or later, or [Node.js](https://nodejs.org/en) 18 or later.
24+
* An [MCP-compatible client](https://modelcontextprotocol.io/clients) that supports MCP tools (latest version recommended).
2525

2626
@[template](/_contentTemplates/common/ai-coding-assistant.md#getting-started)
2727

2828
## Installation
2929

30-
Install the Telerik MAUI MCP server using npm:
30+
Depending on your environment, you can install the Telerik MAUI MCP server in any of the following ways:
3131

32-
```bash
33-
npm i @progress/telerik-maui-mcp
34-
```
32+
* By using the `dnx` script (.NET 10 or later only) or the `dotnet` CLI (.NET 9):
3533

36-
### Configuration
34+
```bash .NET 10
35+
dnx Telerik.MAUI.MCP
36+
```
37+
```bash .NET 9
38+
dotnet tool install Telerik.MAUI.MCP
39+
```
3740

38-
Use these settings when configuring the server in your MCP client:
41+
* By using npm:
3942

40-
| Setting | Value |
41-
|---------|-------|
42-
| Package Name | `@progress/telerik-maui-mcp` |
43-
| Type | `stdio` (standard input/output transport) |
44-
| Command | `npx` |
45-
| Arguments | `-y` |
46-
| Server Name | `telerik-maui-assistant` (customizable) |
43+
```bash
44+
npm i @progress/telerik-maui-mcp
45+
```
4746

48-
### License Configuration
47+
Next, make sure the configuration in your `mcp.json` is [correct](#configuring-mcp-json), and then [add your Telerik license](#configuring-your-license).
4948

50-
Add your [Telerik license key]({%slug set-up-your-license%}) as an environment parameter in your `mcp.json` file using one of these options:
49+
### Configuring mcp.json
5150

52-
Option 1: License File Path (Recommended)
51+
Use the settings in the following table to configure the Telerik MAUI MCP server in the [`mcp.json` file](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) of your code editor. Select the correct value based on your development environment.
5352

54-
```json
55-
"env": {
56-
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE"
57-
}
58-
```
53+
| Setting Name | .NET 10 Value | .NET 9 Value | Node.js Value |
54+
|---------|---------------|-----------------------|---------------|
55+
| Package Name | `"Telerik.MAUI.MCP"` | `"Telerik.MAUI.MCP"` | `"@progress/telerik-maui-mcp"` |
56+
| Type | `"stdio"` | `"stdio"` | `"stdio"` |
57+
| Command | `"dnx"` | `"dotnet"` | `"npx"` |
58+
| Arguments | `"Telerik.MAUI.MCP", "--yes"` | `"tool", "run", "telerik-maui-assistant"` | `"-y"` |
59+
| Server Name | `"telerik-maui-assistant"` | `"telerik-maui-assistant"` | `"telerik-maui-assistant"` |
5960

60-
Option 2: Direct License Key
61+
### Configuring Your License
6162

62-
```json
63-
"env": {
64-
"TELERIK_LICENSE": "YOUR_LICENSE_KEY_HERE"
65-
}
66-
```
63+
An active Telerik UI for .NET MAUI license is required to use the Telerik MAUI MCP server.
6764

68-
> Option 1 is recommended unless you're sharing settings across different systems. Remember to [update your license key]({%slug set-up-your-license%}#updating-your-license-key) when necessary.
65+
* When installing the MCP server by using the .NET tooling (`dnx` or `dotnet tool install`), the [license key file]({%slug set-up-your-license%}) will be retrieved automatically if it is present in the default directory on your system (`%AppData%\Telerik\telerik-license.txt` on Windows and `~/.telerik/telerik-license.txt` on Linux.). No additional action is required.
66+
* When using the .NET tooling, but your [license key file]({%slug set-up-your-license%}) is not in the default directory, use one of the options below.
67+
* When using Node.js, add your [license key file]({%slug set-up-your-license%}) as an environment variable in your `mcp.json` file using one of the options below:
6968

70-
## Visual Studio
69+
* As a license file path (recommended)
7170

72-
For complete setup instructions, see [Use MCP servers in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers).
71+
```json
72+
"env": {
73+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE"
74+
}
75+
```
7376

74-
> Early Visual Studio 17.14 versions require the Copilot Chat window to be open when opening a solution for the MCP server to work properly.
77+
* As a license key value
7578

76-
### Workspace-Specific Setup:
79+
```json
80+
"env": {
81+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY_HERE"
82+
}
83+
```
7784

78-
1. Add `.mcp.json` to your solution folder:
85+
> Using a license file path is recommended unless you're sharing settings across different systems. Remember to [update your license key]({%slug set-up-your-license%}#updating-your-license-key) when necessary.
7986

80-
```json
81-
{
82-
"servers": {
83-
"telerik-maui-assistant": {
84-
"type": "stdio",
85-
"command": "npx",
86-
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
87-
"env": {
88-
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
89-
// or
90-
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
91-
}
92-
}
93-
}
94-
}
95-
```
87+
## Visual Studio
9688

97-
2. Restart Visual Studio.
98-
3. Enable the `telerik-maui-assistant` tool 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).
89+
> * Early Visual Studio 17.14 versions require the Copilot Chat window to be open when a solution loads for the MCP server to work properly.
90+
> * For complete setup instructions, see [Use MCP servers in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers).
9991

100-
### Global Setup:
92+
1. Add an `.mcp.json` file to either of the following locations:
10193

102-
Add the `.mcp.json` file to your user directory (`%USERPROFILE%`, e.g., `C:\Users\YourName\.mcp.json`).
94+
* For a workspace-specific setup, add the file to the solution's folder.
95+
* For a global setup, add the file to your user directory, `%USERPROFILE%` (for example, `C:\Users\YourName\.mcp.json`).
10396

104-
## Visual Studio Code
97+
```json .NET 10
98+
{
99+
"servers": {
100+
"telerik-maui-assistant": {
101+
"type": "stdio",
102+
"command": "dnx",
103+
"args": ["Telerik.MAUI.MCP", "--yes"],
104+
}
105+
}
106+
}
107+
```
108+
```json .NET 9
109+
{
110+
"servers": {
111+
"telerik-maui-assistant": {
112+
"type": "stdio",
113+
"command": "dotnet",
114+
"args": ["tool", "run", "telerik-maui-assistant"],
115+
}
116+
}
117+
}
118+
```
119+
```json Node.js
120+
{
121+
"servers": {
122+
"telerik-maui-assistant": {
123+
"type": "stdio",
124+
"command": "npx",
125+
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
126+
"env": {
127+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
128+
// or
129+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
130+
}
131+
}
132+
}
133+
}
134+
```
105135

106-
For complete setup instructions, see [Use MCP servers in Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
136+
2. Restart Visual Studio.
137+
3. Enable the Telerik MAUI MCP server 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).
107138

108-
> Visual Studio Code 1.102.1 or newer is required to use the Telerik MCP Server
139+
## Visual Studio Code
109140

110-
The basic setup in Visual Studio Code follows these steps:
141+
> * Visual Studio Code 1.102.1 or later is required to use the Telerik MAUI MCP Server.
142+
> * For complete setup instructions, see [Use MCP servers in Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
111143

112-
1. Enable [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) in Visual Studio Code settings.
113-
2. Create `.vscode/mcp.json` in your workspace root (or user folder for global setup):
144+
The basic setup in Visual Studio Code involves the following steps:
114145

115-
```json
116-
{
117-
"servers": {
118-
"telerik-maui-assistant": {
119-
"type": "stdio",
120-
"command": "npx",
121-
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
122-
"env": {
123-
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
124-
// or
125-
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
126-
}
127-
}
128-
}
129-
}
130-
```
146+
1. Enable [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) in the Visual Studio Code settings.
147+
2. Create a `.vscode/mcp.json` file in your workspace root (or user folder for global setup):
148+
149+
```json .NET 10
150+
{
151+
"servers": {
152+
"telerik-maui-assistant": {
153+
"type": "stdio",
154+
"command": "dnx",
155+
"args": ["Telerik.MAUI.MCP", "--yes"],
156+
}
157+
}
158+
}
159+
```
160+
```json .NET 9
161+
{
162+
"servers": {
163+
"telerik-maui-assistant": {
164+
"type": "stdio",
165+
"command": "dotnet",
166+
"args": ["tool", "run", "telerik-maui-assistant"],
167+
}
168+
}
169+
}
170+
```
171+
```json Node.js
172+
{
173+
"servers": {
174+
"telerik-maui-assistant": {
175+
"type": "stdio",
176+
"command": "npx",
177+
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
178+
"env": {
179+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
180+
// or
181+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
182+
}
183+
}
184+
}
185+
}
186+
```
131187

132188
3. For global discovery, enable [`chat.mcp.discovery.enabled`](vscode://settings/chat.mcp.discovery.enabled) in `settings.json`:
133189

134-
```json
135-
{
136-
"chat.mcp.discovery.enabled": true
137-
}
138-
```
190+
```json
191+
{
192+
"chat.mcp.discovery.enabled": true
193+
}
194+
```
139195

140196
4. Restart Visual Studio Code.
141197

142198
## Cursor
143199

144-
For complete setup instructions, see [Model Context Protocol](https://docs.cursor.com/context/mcp).
200+
> For complete setup instructions, see [Model Context Protocol](https://docs.cursor.com/context/mcp).
145201

146-
Create `.cursor/mcp.json` in your workspace root (or user folder for global setup):
202+
Create a `.cursor/mcp.json` file in your workspace root (or user folder for global setup):
147203

148-
```json
204+
```json .NET 10
205+
{
206+
"mcpServers": {
207+
"telerik-maui-assistant": {
208+
"type": "stdio",
209+
"command": "dnx",
210+
"args": ["Telerik.MAUI.MCP", "--yes"],
211+
}
212+
}
213+
}
214+
```
215+
```json .NET 9
216+
{
217+
"mcpServers": {
218+
"telerik-maui-assistant": {
219+
"type": "stdio",
220+
"command": "dotnet",
221+
"args": ["tool", "run", "telerik-maui-assistant"],
222+
}
223+
}
224+
}
225+
```
226+
```json Node.js
149227
{
150228
"mcpServers": {
151229
"telerik-maui-assistant": {
@@ -164,7 +242,9 @@ Create `.cursor/mcp.json` in your workspace root (or user folder for global setu
164242

165243
## Usage
166244

167-
To use the Telerik MCP Server:
245+
By default, MCP clients do not call MCP tools in a deterministic way. Some MCP clients like VS Code allow you to explicitly reference the desired MCP tool in your prompt.
246+
247+
To use the Telerik MAUI MCP server:
168248

169249
1. Start your prompt with one of these triggers:
170250
- `#telerik`
@@ -178,18 +258,19 @@ To use the Telerik MCP Server:
178258

179259
3. Grant permissions when prompted (per session, workspace, or always).
180260

181-
4. Start fresh sessions for unrelated prompts to avoid context pollution.
182-
5. Use in **Chat**(**Ask**) and **Agent** modes.
261+
4. Start a fresh session for unrelated prompts to avoid context pollution.
262+
263+
5. Use in **Chat** (**Ask**) and **Agent** modes.
183264

184265
### Improving Server Usage
185266

186-
To increase the likelihood of the Telerik MCP server being used, add custom instructions to your AI tool:
267+
To increase the likelihood of the Telerik MAUI MCP server being used, add custom instructions to your AI tool:
187268
- [GitHub Copilot custom instructions](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot#about-repository-custom-instructions-for-github-copilot-chat)
188269
- [Cursor rules](https://docs.cursor.com/context/rules)
189270

190271
### Sample Prompts
191272

192-
The following examples demonstrate useful prompts for the Telerik .NET MAUI MCP Server:
273+
The following examples demonstrate useful prompts for the Telerik MAUI MCP server:
193274

194275
* "`#telerik-maui-assistant Create new maui project with Telerik. Add sample usage of the DataGrid component.`"
195276
* "`#telerik-maui-assistant Create a DataGrid with 3 columns - Name, Country, City. Add the corresponding business object in the code behind and populate it with sample data. Add 20 entries to the data.`"
@@ -203,9 +284,9 @@ The following examples demonstrate useful prompts for the Telerik .NET MAUI MCP
203284

204285
You can use the Telerik MAUI MCP server with local large language models (LLMs):
205286

206-
1. Run a local model, for example, through [Ollama](https://ollama.com).
287+
1. Run a local model, for example, [Ollama](https://ollama.com).
207288
2. Use a bridge package like [MCP-LLM Bridge](https://github.com/patruff/ollama-mcp-bridge).
208-
3. Connect your local model to the Telerik MCP server.
289+
3. Connect your local model to the Telerik MAUI MCP server.
209290

210291
This setup allows you to use the Telerik AI Coding Assistant without cloud-based AI models.
211292

0 commit comments

Comments
 (0)