Skip to content

Commit 5ab4f7c

Browse files
authored
Merge pull request #761 from telerik/Q3_2025
Q3 2025 docs
2 parents 6d4dcf4 + 3c0af07 commit 5ab4f7c

File tree

53 files changed

+1252
-173
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1252
-173
lines changed

_config.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ navigation:
2626
title: Visual Studio Extensions
2727
position: 4
2828
core:
29-
title: NET Core
29+
title: .NET Support
3030
position: 5
3131
winforms-converter:
3232
title: WinForms application modernization wizard
@@ -43,18 +43,21 @@ navigation:
4343
styling-and-appearance:
4444
title: Styling and Appearance
4545
position: 9
46+
ai-coding-assistant:
47+
title: AI Coding Assistant
48+
position: 10
4649
tools:
4750
title: Tools
48-
position: 10
51+
position: 11
4952
integration-with-other-telerik-products:
5053
title: Integration with Other Telerik Products
51-
position: 11
54+
position: 12
5255
testing:
5356
title: Testing
54-
position: 12
57+
position: 13
5558
deployment-and-distribution:
5659
title: Deployment and Distribution
57-
position: 13
60+
position: 14
5861
security:
5962
title: Security
6063
position: 15
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Copilot Extension
3+
page_title: Telerik WinForms GitHub Copilot Extension
4+
description: Learn how to add and use the Telerik WinForms GitHub Copilot extension as a WinForms AI coding assistant and code generator for better developer productivity. The Telerik WinForms GitHub Copilot extension provides proprietary context about Telerik UI for WinForms to AI-powered software.
5+
slug: ai-copilot-extension
6+
tags: telerik, WinForms, ai, coding assistant, ai server
7+
position: 1
8+
---
9+
10+
# Telerik WinForms GitHub Copilot Extension
11+
12+
The Telerik WinForms [GitHub Copilot](https://github.com/features/copilot) extension is an AI-powered coding assistant that provides specialized knowledge about [Telerik UI for WinForms components](https://www.telerik.com/products/winforms.aspx).
13+
14+
This extension enhances GitHub Copilot with proprietary context about Telerik WinForms controls, helping you:
15+
16+
* Generate code snippets using Telerik WinForms 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.
20+
21+
## Prerequisites
22+
23+
Before using the Telerik WinForms GitHub Copilot extension, ensure you have:
24+
25+
* An active [GitHub Copilot](https://github.com/features/copilot) subscription. You can enable or configure GitHub Copilot on the [Copilot Settings page in your GitHub account](https://github.com/settings/copilot).
26+
* A [Telerik user account](https://www.telerik.com/account/?_gl=1*rbcezh*_gcl_au*NzA0NDU3NzU1LjE3NTA2NTk3NDY.*_ga*ODUxNTg5NDI5LjE2OTU2NDQ2ODI.*_ga_9JSNBCSF54*czE3NTQ1NDQ5MTQkbzE0NSRnMSR0MTc1NDU3MjMxMiRqMzAkbDAkaDA.).
27+
* An active [DevCraft or Telerik UI for WinForms license](https://www.telerik.com/purchase/individual/winforms.aspx) or a [Telerik UI for WinForms trial](https://www.telerik.com/try/ui-for-winforms).
28+
* A [WinForms application that includes Telerik UI for WinForms](https://docs.telerik.com/devtools/winforms/getting-started/first-steps).
29+
* 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) (for example, Visual Studio or Visual Studio Code).
30+
31+
## Installation
32+
33+
Follow these steps to install and configure the Telerik WinForms Copilot extension:
34+
35+
1. Go to the [Telerik WinForms GitHub App](https://github.com/apps/telerikwinforms) page and click the **Install** button.
36+
1. You will see a list that includes your GitHub account and all GitHub organizations that you are part of. Select your GitHub account.
37+
1. Click the **Install & Allow** button. This will allow the GitHub Copilot extension to integrate with your GitHub account.
38+
1. Enter your GitHub password when prompted.
39+
1. You will be redirected to telerik.com. Enter your Telerik account credentials if prompted. This step links the GitHub Copilot extension with your Telerik account.
40+
1. Upon successful Telerik authentication, you will be redirected to a confirmation page that indicates successful Copilot extension installation.
41+
1. Restart your [Copilot-enabled app](https://docs.github.com/en/copilot/building-copilot-extensions/about-building-copilot-extensions#supported-clients-and-ides) (for example, Visual Studio and Visual Studio Code).
42+
1. Start a new chat session in Copilot.
43+
44+
## Usage
45+
46+
To use the Telerik WinForms Copilot extension:
47+
48+
1. Open the GitHub Copilot chat window in your [Copilot-enabled app](https://docs.github.com/en/copilot/building-copilot-extensions/about-building-copilot-extensions#supported-clients-and-ides) (for example, Visual Studio or VS Code).
49+
1. Ensure you are in **Chat** mode and not in **Edit** or **Agent** mode. The Edit and Agent modes do not use the Telerik Copilot extension. However, the Agent mode can use the [Telerik WinForms MCP server]({%slug ai-mcp-server%}).
50+
1. Start your prompt with `@telerikmaui` and type your request. Verify that `@telerikmaui` is recognized and highlighted; otherwise, the extension may not be properly installed.
51+
1. Look for a status label such as **Telerik WinForms working...** or **Telerik WinForms generating response...** in the output to confirm the extension is active.
52+
1. Grant permission to the Telerik WinForms extension to read your workspace files when prompted.
53+
1. For unrelated queries, start a new chat session in a new window to avoid context pollution from previous conversations.
54+
55+
### Sample Prompts
56+
57+
The following examples demonstrate useful prompts for the Telerik WinForms extension:
58+
59+
* "`@telerikwinforms` Generate a Grid with sorting and paging enabled."
60+
* "`@telerikwinforms` Create a Telerik RadDropDownlist for WinForms with multiple selection enabled."
61+
* "`@telerikwinforms` Show me how to implement a ChartView with line series."
62+
* "`@telerikwinforms` Show me how to size all columns in GridView to take all the available space."
63+
64+
## Number of Requests
65+
66+
A Telerik [Subscription license](https://www.telerik.com/purchase/faq/licensing-purchasing) is recommended in order to use the Telerik WinForms 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).
67+
68+
## Troubleshooting
69+
70+
If you encounter issues:
71+
72+
* Ensure the `@telerikwinforms` mention is properly highlighted in your prompt.
73+
* Verify that you have an active GitHub Copilot subscription.
74+
* Restart your IDE after installation.
75+
* Check that you're in Chat mode, not Edit or Agent mode.
76+
77+
## See Also
78+
79+
* [GitHub Copilot Documentation](https://docs.github.com/en/copilot)
80+
* [GitHub Copilot Tutorials](https://github.com/features/copilot/tutorials)
81+
* [Telerik WinForms MCP Server]({%slug ai-mcp-server%})
82+
* [Telerik UI for WinForms Documentation](https://docs.telerik.com/devtools/winforms/introduction)

ai-coding-assistant/mcp-server.md

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
---
2+
title: MCP Server
3+
page_title: Telerik WinForms MCP Server
4+
description: Learn how to add and use the Telerik WinForms MCP Server as a WinForms AI coding assistant and code generator for better developer productivity. The Telerik WinForms MCP server provides proprietary context about Telerik UI for WinForms to AI-powered software.
5+
slug: ai-mcp-server
6+
tags: telerik,winforms,ai,ai server,coding assistant
7+
position: 2
8+
---
9+
10+
# Telerik WinForms MCP Server
11+
12+
The Telerik WinForms [MCP (Model Context Protocol) Server](https://modelcontextprotocol.io/introduction) enhances your AI-powered development experience by providing specialized context about Telerik UI for WinForms components.
13+
14+
This MCP server enables AI-powered IDEs and tools to generate more accurate, tailored code that leverages [Telerik UI for WinForms components](https://docs.telerik.com/devtools/winforms/introduction) and APIs. You can ask complex questions about Telerik components, request specific implementations, and generate comprehensive code solutions.
15+
16+
## Prerequisites
17+
18+
To use the Telerik WinForms MCP server, you need:
19+
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).
22+
* A [Telerik user account](https://www.telerik.com/account/?_gl=1*rbcezh*_gcl_au*NzA0NDU3NzU1LjE3NTA2NTk3NDY.*_ga*ODUxNTg5NDI5LjE2OTU2NDQ2ODI.*_ga_9JSNBCSF54*czE3NTQ1NDQ5MTQkbzE0NSRnMSR0MTc1NDU3MjMxMiRqMzAkbDAkaDA.).
23+
* An active [DevCraft or Telerik UI for WinForms license](https://www.telerik.com/purchase/individual/winforms.aspx) or a [Telerik UI for WinForms trial](https://www.telerik.com/try/ui-for-winforms).
24+
* A [WinForms application that includes Telerik UI for WinForms](https://docs.telerik.com/devtools/winforms/getting-started/first-steps).
25+
26+
## Installation
27+
28+
Install the Telerik WinForms MCP server using npm:
29+
30+
```bash
31+
npm i @progress/telerik-winforms-mcp
32+
```
33+
34+
### Configuration
35+
36+
Use these settings when configuring the server in your MCP client:
37+
38+
| Setting | Value |
39+
|---------|-------|
40+
| Package Name | `@progress/telerik-winforms-mcp` |
41+
| Type | `stdio` (standard input/output transport) |
42+
| Command | `npx` |
43+
| Arguments | `-y` |
44+
| Server Name | `telerikWinFormsAssistant` (customizable) |
45+
46+
### License Configuration
47+
48+
Add your [Telerik license key]({%slug license-key%}) as an environment parameter in your `mcp.json` file using one of these options:
49+
50+
Option 1: License File Path (Recommended)
51+
52+
```json
53+
"env": {
54+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE"
55+
}
56+
```
57+
58+
Option 2: Direct License Key
59+
60+
```json
61+
"env": {
62+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY_HERE"
63+
}
64+
```
65+
66+
> Option 1 is recommended unless you're sharing settings across different systems. Remember to [update your license key]({%slug license-key%}#updating-your-license-key) when necessary.
67+
68+
## Visual Studio
69+
70+
For complete setup instructions, see [Use MCP servers in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers).
71+
72+
> 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.
73+
74+
### Workspace-Specific Setup:
75+
76+
1. Add `.mcp.json` to your solution folder:
77+
78+
```json
79+
{
80+
"servers": {
81+
"telerikWinFormsAssistant": {
82+
"type": "stdio",
83+
"command": "npx",
84+
"args": ["-y", "@progress/telerik-winforms-mcp@latest"],
85+
"env": {
86+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
87+
// or
88+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
89+
}
90+
}
91+
}
92+
}
93+
```
94+
95+
2. Restart Visual Studio.
96+
3. Enable the `telerikWinFormsAssistant` 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).
97+
98+
### Global Setup:
99+
100+
Add the `.mcp.json` file to your user directory (`%USERPROFILE%`, e.g., `C:\Users\YourName\.mcp.json`).
101+
102+
## Visual Studio Code
103+
104+
For complete setup instructions, see [Use MCP servers in Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
105+
106+
> Visual Studio Code 1.102.1 or newer is required to use the Telerik MCP Server
107+
108+
The basic setup in Visual Studio Code follows these steps:
109+
110+
1. Enable [`chat.mcp.enabled`](vscode://settings/chat.mcp.enabled) in Visual Studio Code settings.
111+
2. Create `.vscode/mcp.json` in your workspace root (or user folder for global setup):
112+
113+
```json
114+
{
115+
"servers": {
116+
"telerik-winforms-assistant": {
117+
"type": "stdio",
118+
"command": "npx",
119+
"args": ["-y", "@progress/telerik-winforms-mcp@latest"],
120+
"env": {
121+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
122+
// or
123+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
124+
}
125+
}
126+
}
127+
}
128+
```
129+
130+
3. For global discovery, enable [`chat.mcp.discovery.enabled`](vscode://settings/chat.mcp.discovery.enabled) in `settings.json`:
131+
132+
```json
133+
{
134+
"chat.mcp.discovery.enabled": true
135+
}
136+
```
137+
138+
4. Restart Visual Studio Code.
139+
140+
## Cursor
141+
142+
For complete setup instructions, see [Model Context Protocol](https://docs.cursor.com/context/mcp).
143+
144+
Create `.cursor/mcp.json` in your workspace root (or user folder for global setup):
145+
146+
```json
147+
{
148+
"mcpServers": {
149+
"telerikWinFormsAssistant": {
150+
"type": "stdio",
151+
"command": "npx",
152+
"args": ["-y", "@progress/telerik-winforms-mcp@latest"],
153+
"env": {
154+
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
155+
// or
156+
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
157+
}
158+
}
159+
}
160+
}
161+
```
162+
163+
## Usage
164+
165+
To use the Telerik MCP Server:
166+
167+
1. Start your prompt with one of these triggers:
168+
- `/telerik` / `@telerik` / `#telerik`
169+
- `/telerikwinforms` / `@telerikwinforms` / `#telerikwinforms`
170+
- `#telerik-winforms-assistant`
171+
172+
2. Verify server activation by looking for these messages:
173+
- Visual Studio: `Running telerikWinFormsAssistant`
174+
- Visual Studio Code: `Running telerik-winforms-assistant`
175+
- Cursor: `Calling MCP tool telerikWinFormsAssistant`
176+
177+
3. Grant permissions when prompted (per session, workspace, or always).
178+
179+
4. Start fresh sessions for unrelated prompts to avoid context pollution.
180+
181+
### Improving Server Usage
182+
183+
To increase the likelihood of the Telerik MCP server being used, add custom instructions to your AI tool:
184+
- [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)
185+
- [Cursor rules](https://docs.cursor.com/context/rules)
186+
187+
### Sample Prompts
188+
189+
The following examples demonstrate useful prompts for the Telerik WinForms MCP Server:
190+
191+
* "`/telerik` Generate a DataGrid with sorting and paging. Bind it to a Person model with sample ViewModel."
192+
* "`/telerikwinforms` Create a ComboBox showing a product list. Include Product class and sample data."
193+
* "`/telerik` Build a CollectionView with sorting and filtering capabilities."
194+
195+
## Number of Requests
196+
197+
A Telerik [Subscription license](https://www.telerik.com/purchase/faq/licensing-purchasing) is recommended in order to use the Telerik WinForms 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).
198+
199+
## Local AI Model Integration
200+
201+
You can use the Telerik WinForms MCP server with local large language models (LLMs):
202+
203+
1. Run a local model, for example, through [Ollama](https://ollama.com).
204+
2. Use a bridge package like [MCP-LLM Bridge](https://github.com/patruff/ollama-mcp-bridge).
205+
3. Connect your local model to the Telerik MCP server.
206+
207+
This setup allows you to use the Telerik AI Coding Assistant without cloud-based AI models.
208+
209+
## See Also
210+
211+
* [Telerik WinForms GitHub Copilot Extension]({%slug ai-copilot-extension%})
212+
* [AI Coding Assistant Overview]({%slug ai-overview%})

0 commit comments

Comments
 (0)