Skip to content

Commit aeaad74

Browse files
committed
address comments
1 parent 4e86a64 commit aeaad74

File tree

3 files changed

+83
-83
lines changed

3 files changed

+83
-83
lines changed

ai/copilot-extension.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ The Telerik MAUI [GitHub Copilot](https://github.com/features/copilot) extension
1313

1414
This extension enhances GitHub Copilot with proprietary context about Telerik MAUI controls, helping you:
1515

16-
* Generate code snippets using Telerik MAUI components
17-
* Get contextual suggestions for component properties and methods
18-
* Access best practices and implementation patterns
19-
* Speed up development with AI-powered code completion
16+
* Generate code snippets using Telerik MAUI components.
17+
* Get contextual suggestions for component properties and methods.
18+
* Access best practices and implementation patterns.
19+
* Speed up development with AI-powered code completion.
2020

2121
## Prerequisites
2222

@@ -67,10 +67,10 @@ The following examples demonstrate useful prompts for the Telerik MAUI extension
6767

6868
If you encounter issues:
6969

70-
* Ensure the `@telerikmaui` mention is properly highlighted in your prompt
71-
* Verify that you have an active GitHub Copilot subscription
72-
* Restart your IDE after installation
73-
* Check that you're in Chat mode, not Edit or Agent mode
70+
* Ensure the `@telerikmaui` mention is properly highlighted in your prompt.
71+
* Verify that you have an active GitHub Copilot subscription.
72+
* Restart your IDE after installation.
73+
* Check that you're in Chat mode, not Edit or Agent mode.
7474

7575
## See Also
7676

ai/mcp-server.md

Lines changed: 61 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ This MCP server enables AI-powered IDEs and tools to generate more accurate, tai
1717

1818
To use the Telerik MAUI MCP server, you need:
1919

20-
* [Node.js](https://nodejs.org/en) 18 or newer
21-
* An [MCP-compatible client](https://modelcontextprotocol.io/clients) that supports **MCP tools** (latest version recommended)
20+
* [Node.js](https://nodejs.org/en) 18 or newer.
21+
* An [MCP-compatible client](https://modelcontextprotocol.io/clients) that supports **MCP tools** (latest version recommended).
2222

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

@@ -46,19 +46,21 @@ Use these settings when configuring the server in your MCP client:
4646

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

49-
**Option 1: License File Path (Recommended)**
50-
```json
51-
"env": {
52-
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FIL"
53-
}
54-
```
49+
Option 1: License File Path (Recommended)
5550

56-
**Option 2: Direct License Key**
57-
```json
58-
"env": {
59-
"TELERIK_LICENSE": "YOUR_LICENSE_KEY_HERE"
60-
}
61-
```
51+
```json
52+
"env": {
53+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FIL"
54+
}
55+
```
56+
57+
Option 2: Direct License Key
58+
59+
```json
60+
"env": {
61+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY_HERE"
62+
}
63+
```
6264

6365
> 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.
6466
@@ -68,72 +70,73 @@ For complete setup instructions, see [Use MCP servers in Visual Studio](https://
6870

6971
> 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.
7072
71-
**Workspace-Specific Setup:**
73+
### Workspace-Specific Setup:
7274

7375
1. Add `.mcp.json` to your solution folder:
7476

75-
```json
76-
{
77-
"servers": {
78-
"telerikMauiAssistant": {
79-
"type": "stdio",
80-
"command": "npx",
81-
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
82-
"env": {
83-
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
84-
// or
85-
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
86-
}
87-
}
88-
}
89-
}
90-
```
77+
```json
78+
{
79+
"servers": {
80+
"telerikMauiAssistant": {
81+
"type": "stdio",
82+
"command": "npx",
83+
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
84+
"env": {
85+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
86+
// or
87+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
88+
}
89+
}
90+
}
91+
}
92+
```
9193

9294
2. Restart Visual Studio.
9395
3. Enable the `telerikMauiAssistant` 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).
9496

95-
**Global Setup:**
97+
### Global Setup:
98+
9699
Add the `.mcp.json` file to your user directory (`%USERPROFILE%`, e.g., `C:\Users\YourName\.mcp.json`).
97100

98-
### Visual Studio Code
101+
## Visual Studio Code
99102

100103
For complete setup instructions, see [Use MCP servers in Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
101104

102105
> Visual Studio Code 1.102.1 or newer is required to use the Telerik MCP Server
103106
104-
**Setup Steps:**
107+
The basic setup in Visual Studio Code follows these steps:
105108

106109
1. Enable [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) in Visual Studio Code settings.
107110
2. Create `.vscode/mcp.json` in your workspace root (or user folder for global setup):
108111

109-
```json
110-
{
111-
"servers": {
112-
"telerik-maui-assistant": {
113-
"type": "stdio",
114-
"command": "npx",
115-
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
116-
"env": {
117-
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
118-
// or
119-
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
120-
}
121-
}
122-
}
123-
}
124-
```
112+
```json
113+
{
114+
"servers": {
115+
"telerik-maui-assistant": {
116+
"type": "stdio",
117+
"command": "npx",
118+
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
119+
"env": {
120+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
121+
// or
122+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
123+
}
124+
}
125+
}
126+
}
127+
```
125128

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

128-
```json
129-
{
130-
"chat.mcp.discovery.enabled": true
131-
}
132-
```
131+
```json
132+
{
133+
"chat.mcp.discovery.enabled": true
134+
}
135+
```
133136

134137
4. Restart Visual Studio Code.
135138

136-
### Cursor
139+
## Cursor
137140

138141
For complete setup instructions, see [Model Context Protocol](https://docs.cursor.com/context/mcp).
139142

@@ -182,6 +185,7 @@ To increase the likelihood of the Telerik MCP server being used, add custom inst
182185

183186
### Sample Prompts
184187

188+
The following examples demonstrate useful prompts for the Telerik .NET MAUI MCP Server:
185189

186190
"`/telerik` Generate a DataGrid with sorting and paging. Bind it to a Person model with sample ViewModel."
187191

@@ -198,7 +202,7 @@ To increase the likelihood of the Telerik MCP server being used, add custom inst
198202

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

201-
1. Run a local model through [Ollama](https://ollama.com).
205+
1. Run a local model, for example, through [Ollama](https://ollama.com).
202206
2. Use a bridge package like [MCP-LLM Bridge](https://github.com/patruff/ollama-mcp-bridge).
203207
3. Connect your local model to the Telerik MCP server.
204208

ai/overview.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,12 @@ The Telerik AI Coding Assistant is available through:
2222

2323
### Key Differences
2424

25-
**MCP Server:**
26-
* More powerful and handles complex, multi-step prompts
27-
* Works with MCP-enabled clients like Cursor or GitHub Copilot in Agent mode
28-
* Can directly suggest changes and rebuild applications to verify generated code
29-
* Responses are primarily code-focused
30-
31-
**GitHub Copilot Extension:**
32-
* Provides detailed explanations alongside code suggestions
33-
* Offers shorter, focused code snippets
34-
* Better for learning and understanding implementation approaches
25+
| Feature | MCP Server | GitHub Copilot Extension |
26+
|------------------------|---------------------------------------------------------------------------|------------------------------------------------------------|
27+
| Prompt Handling | Handles complex, multi-step prompts | Offers shorter, focused code snippets |
28+
| Client Compatibility | Works with MCP-enabled clients (e.g., Cursor, Copilot Agent mode) | Integrated as a Copilot extension |
29+
| Code Suggestions | Can directly suggest changes and rebuild applications to verify code | Provides detailed explanations alongside code suggestions |
30+
| Response Focus | Primarily code-focused | Better for learning and understanding implementation |
3531

3632
## Getting Started
3733

@@ -46,31 +42,31 @@ The Telerik MAUI AI Coding Assistant allows the following maximum number of requ
4642

4743
| License Type | Request Limit |
4844
|--------------|---------------|
49-
| **Perpetual** | 50 requests per year |
50-
| **Subscription** | Virtually unlimited with fair use threshold of 300 requests per day |
51-
| **Trial** | 300 requests per trial period (does not reset with new trial activations) |
45+
| Perpetual | 50 requests per year |
46+
| Subscription | Virtually unlimited with fair use threshold of 300 requests per day |
47+
| Trial | 300 requests per trial period (does not reset with new trial activations) |
5248

53-
> **Important:** All Telerik AI tools share a single request quota for your Telerik account. Usage from the [Telerik Copilot extension]({%slug ai-copilot-extension%}) and [Telerik MCP server]({%slug ai-mcp-server%}) counts toward the same limit. Complex prompts in the MCP server may consume multiple requests.
49+
> All Telerik AI tools share a single request quota for your Telerik account. Usage from the [Telerik Copilot extension]({%slug ai-copilot-extension%}) and [Telerik MCP server]({%slug ai-mcp-server%}) counts toward the same limit. Complex prompts in the MCP server may consume multiple requests.
5450
5551
## Privacy
5652

5753
The Telerik MAUI AI Coding Assistant operates under strict privacy guidelines:
5854

59-
**Data Access:**
55+
Data Access:
6056
* No access to your workspace and application code.
6157
* Exception: when using the Telerik MCP server (or any other MCP server), the LLM generates parameters for the MCP server request, which may include parts of your application code.
6258

63-
**Data Usage:**
59+
Data Usage:
6460
* Your prompts are not used to train Telerik AI models.
6561
* Does not generate or access AI responses.
6662
* Provides enhanced context to improve responses from your chosen AI model (GPT, Gemini, Claude, etc.).
6763

68-
**Data Storage:**
64+
Data Storage:
6965
* Prompts and context are anonymized and stored only for statistical analysis and troubleshooting.
7066
* No association between prompts and your Telerik user account.
7167
* Usage metrics are collected to ensure [license compliance](#number-of-requests).
7268

73-
> Review the terms and privacy policies of your selected AI model and AI client.
69+
> Make sure also to review the terms and privacy policies of your selected AI model and AI client.
7470
7571
## Next Steps
7672

0 commit comments

Comments
 (0)