Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
a4c005f
Document the global UI Automation setting
nade7o Aug 4, 2025
5960aca
Update in ui automation
nade7o Aug 4, 2025
149135e
Document 2 new events in RTE
nade7o Aug 4, 2025
885711a
Document 2 new events in Spreadsheet
nade7o Aug 4, 2025
b31e847
Small updates in How to Upgrade Telerik UI for WinForms Project
nade7o Aug 5, 2025
01aa81e
Update Net Core > Design time
nade7o Aug 6, 2025
6826a40
fix tags
nade7o Aug 6, 2025
6997239
Update: deploy-application
nade7o Aug 6, 2025
9dea497
Update: core-toolbox-version
nade7o Aug 6, 2025
caa8e13
Add ReportViewer article
DinkoK Aug 6, 2025
a355c65
Updata: core-migration
nade7o Aug 6, 2025
ad0cd60
Merge branch 'Q3_2025' of https://github.com/telerik/winforms-docs in…
nade7o Aug 6, 2025
a4ef8a6
Update: core-project-and-document-processing-library
nade7o Aug 6, 2025
05fa45e
change net title in _confiq.yml
nade7o Aug 6, 2025
b17dd81
Add: .NET overview
nade7o Aug 6, 2025
93f29bc
Map: Described new Azure Map Provider
DinkoK Aug 6, 2025
d0d5544
small fixes
nade7o Aug 6, 2025
bc759fa
Merge branch 'Q3_2025' of https://github.com/telerik/winforms-docs in…
nade7o Aug 6, 2025
2175e87
add description
nade7o Aug 6, 2025
0e1ace1
RadMap: Fix broken slug
DinkoK Aug 6, 2025
af75ea8
fixes
nade7o Aug 6, 2025
d67c635
fix example numbering
nade7o Aug 6, 2025
beabe49
RadGridView: Add UI Automation article
DinkoK Aug 6, 2025
1aac071
RadGridView: UI Automation Small update
DinkoK Aug 7, 2025
810a5ae
GridView: Automation, more updates
DinkoK Aug 7, 2025
9158a73
AI Coding Assistant: Add Docs
DinkoK Aug 7, 2025
4fafecb
Fix broken slugs
DinkoK Aug 7, 2025
1fbdce6
ADD Spreadsheet Current Region
nade7o Aug 8, 2025
d512b80
fic typo
nade7o Aug 8, 2025
0690b6f
update images in vsx > create project
nade7o Aug 11, 2025
fd5d56f
new pics
nade7o Aug 11, 2025
9bbc75b
more new pics
nade7o Aug 11, 2025
693f260
more new pics
nade7o Aug 11, 2025
400053e
GridView: UI Automation Minor Update
DinkoK Aug 11, 2025
dc3eca7
GridView: Update UI ui-automation
DinkoK Aug 11, 2025
1daa9d3
GridView: Update UI Automation
DinkoK Aug 11, 2025
81061e0
Add space
icom85 Aug 11, 2025
b08da74
Update vse overview
nade7o Aug 11, 2025
3c0af07
Add indentation to grid UIA article
icom85 Aug 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ navigation:
title: Visual Studio Extensions
position: 4
core:
title: NET Core
title: .NET Support
position: 5
winforms-converter:
title: WinForms application modernization wizard
Expand All @@ -43,18 +43,21 @@ navigation:
styling-and-appearance:
title: Styling and Appearance
position: 9
ai-coding-assistant:
title: AI Coding Assistant
position: 10
tools:
title: Tools
position: 10
position: 11
integration-with-other-telerik-products:
title: Integration with Other Telerik Products
position: 11
position: 12
testing:
title: Testing
position: 12
position: 13
deployment-and-distribution:
title: Deployment and Distribution
position: 13
position: 14
security:
title: Security
position: 15
Expand Down
82 changes: 82 additions & 0 deletions ai-coding-assistant/copilot-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Copilot Extension
page_title: Telerik WinForms GitHub Copilot Extension
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.
slug: ai-copilot-extension
tags: telerik, WinForms, ai, coding assistant, ai server
position: 1
---

# Telerik WinForms GitHub Copilot Extension

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).

This extension enhances GitHub Copilot with proprietary context about Telerik WinForms controls, helping you:

* Generate code snippets using Telerik WinForms components.
* Get contextual suggestions for component properties and methods.
* Access best practices and implementation patterns.
* Speed up development with AI-powered code completion.

## Prerequisites

Before using the Telerik WinForms GitHub Copilot extension, ensure you have:

* 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).
* A [Telerik user account](https://www.telerik.com/account/?_gl=1*rbcezh*_gcl_au*NzA0NDU3NzU1LjE3NTA2NTk3NDY.*_ga*ODUxNTg5NDI5LjE2OTU2NDQ2ODI.*_ga_9JSNBCSF54*czE3NTQ1NDQ5MTQkbzE0NSRnMSR0MTc1NDU3MjMxMiRqMzAkbDAkaDA.).
* 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).
* A [WinForms application that includes Telerik UI for WinForms](https://docs.telerik.com/devtools/winforms/getting-started/first-steps).
* 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).

## Installation

Follow these steps to install and configure the Telerik WinForms Copilot extension:

1. Go to the [Telerik WinForms GitHub App](https://github.com/apps/telerikwinforms) page and click the **Install** button.
1. You will see a list that includes your GitHub account and all GitHub organizations that you are part of. Select your GitHub account.
1. Click the **Install & Allow** button. This will allow the GitHub Copilot extension to integrate with your GitHub account.
1. Enter your GitHub password when prompted.
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.
1. Upon successful Telerik authentication, you will be redirected to a confirmation page that indicates successful Copilot extension installation.
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).
1. Start a new chat session in Copilot.

## Usage

To use the Telerik WinForms Copilot extension:

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).
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%}).
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.
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.
1. Grant permission to the Telerik WinForms extension to read your workspace files when prompted.
1. For unrelated queries, start a new chat session in a new window to avoid context pollution from previous conversations.

### Sample Prompts

The following examples demonstrate useful prompts for the Telerik WinForms extension:

* "`@telerikwinforms` Generate a Grid with sorting and paging enabled."
* "`@telerikwinforms` Create a Telerik RadDropDownlist for WinForms with multiple selection enabled."
* "`@telerikwinforms` Show me how to implement a ChartView with line series."
* "`@telerikwinforms` Show me how to size all columns in GridView to take all the available space."

## Number of Requests

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).

## Troubleshooting

If you encounter issues:

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

## See Also

* [GitHub Copilot Documentation](https://docs.github.com/en/copilot)
* [GitHub Copilot Tutorials](https://github.com/features/copilot/tutorials)
* [Telerik WinForms MCP Server]({%slug ai-mcp-server%})
* [Telerik UI for WinForms Documentation](https://docs.telerik.com/devtools/winforms/introduction)
212 changes: 212 additions & 0 deletions ai-coding-assistant/mcp-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
---
title: MCP Server
page_title: Telerik WinForms MCP Server
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.
slug: ai-mcp-server
tags: telerik,winforms,ai,ai server,coding assistant
position: 2
---

# Telerik WinForms MCP Server

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.

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.

## Prerequisites

To use the Telerik WinForms MCP server, you need:

* [Node.js](https://nodejs.org/en) 18 or newer.
* An [MCP-compatible client](https://modelcontextprotocol.io/clients) that supports **MCP tools** (latest version recommended).
* A [Telerik user account](https://www.telerik.com/account/?_gl=1*rbcezh*_gcl_au*NzA0NDU3NzU1LjE3NTA2NTk3NDY.*_ga*ODUxNTg5NDI5LjE2OTU2NDQ2ODI.*_ga_9JSNBCSF54*czE3NTQ1NDQ5MTQkbzE0NSRnMSR0MTc1NDU3MjMxMiRqMzAkbDAkaDA.).
* 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).
* A [WinForms application that includes Telerik UI for WinForms](https://docs.telerik.com/devtools/winforms/getting-started/first-steps).

## Installation

Install the Telerik WinForms MCP server using npm:

```bash
npm i @progress/telerik-winforms-mcp
```

### Configuration

Use these settings when configuring the server in your MCP client:

| Setting | Value |
|---------|-------|
| Package Name | `@progress/telerik-winforms-mcp` |
| Type | `stdio` (standard input/output transport) |
| Command | `npx` |
| Arguments | `-y` |
| Server Name | `telerikWinFormsAssistant` (customizable) |

### License Configuration

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

Option 1: License File Path (Recommended)

```json
"env": {
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE"
}
```

Option 2: Direct License Key

```json
"env": {
"TELERIK_LICENSE": "YOUR_LICENSE_KEY_HERE"
}
```

> 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.

## Visual Studio

For complete setup instructions, see [Use MCP servers in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers).

> 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.

### Workspace-Specific Setup:

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

```json
{
"servers": {
"telerikWinFormsAssistant": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@progress/telerik-winforms-mcp@latest"],
"env": {
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
// or
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
}
}
}
}
```

2. Restart Visual Studio.
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).

### Global Setup:

Add the `.mcp.json` file to your user directory (`%USERPROFILE%`, e.g., `C:\Users\YourName\.mcp.json`).

## Visual Studio Code

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

> Visual Studio Code 1.102.1 or newer is required to use the Telerik MCP Server

The basic setup in Visual Studio Code follows these steps:

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

```json
{
"servers": {
"telerik-winforms-assistant": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@progress/telerik-winforms-mcp@latest"],
"env": {
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
// or
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
}
}
}
}
```

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

```json
{
"chat.mcp.discovery.enabled": true
}
```

4. Restart Visual Studio Code.

## Cursor

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

Create `.cursor/mcp.json` in your workspace root (or user folder for global setup):

```json
{
"mcpServers": {
"telerikWinFormsAssistant": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@progress/telerik-winforms-mcp@latest"],
"env": {
"TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
// or
"TELERIK_LICENSE": "YOUR_LICENSE_KEY"
}
}
}
}
```

## Usage

To use the Telerik MCP Server:

1. Start your prompt with one of these triggers:
- `/telerik` / `@telerik` / `#telerik`
- `/telerikwinforms` / `@telerikwinforms` / `#telerikwinforms`
- `#telerik-winforms-assistant`

2. Verify server activation by looking for these messages:
- Visual Studio: `Running telerikWinFormsAssistant`
- Visual Studio Code: `Running telerik-winforms-assistant`
- Cursor: `Calling MCP tool telerikWinFormsAssistant`

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

4. Start fresh sessions for unrelated prompts to avoid context pollution.

### Improving Server Usage

To increase the likelihood of the Telerik MCP server being used, add custom instructions to your AI tool:
- [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)
- [Cursor rules](https://docs.cursor.com/context/rules)

### Sample Prompts

The following examples demonstrate useful prompts for the Telerik WinForms MCP Server:

* "`/telerik` Generate a DataGrid with sorting and paging. Bind it to a Person model with sample ViewModel."
* "`/telerikwinforms` Create a ComboBox showing a product list. Include Product class and sample data."
* "`/telerik` Build a CollectionView with sorting and filtering capabilities."

## Number of Requests

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).

## Local AI Model Integration

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

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

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

## See Also

* [Telerik WinForms GitHub Copilot Extension]({%slug ai-copilot-extension%})
* [AI Coding Assistant Overview]({%slug ai-overview%})
Loading