Merge pull request #781 from telerik/dkrastev/m-ai-assistant

Add AI Assistant Code

Author: nade7o

ai-coding-assistant/copilot-extension.md

@@ -0,0 +1,86 @@
+---
+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 `@telerikwinforms` and type your request. Verify that `@telerikwinforms` 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` Create a RadGridView with 100 records each having Id, Name and Company. Group the data by Company. Sort by name. Add aggregate count function for the company column."
+* "`@telerikwinforms` Create a RadGridView with 100 employees records with two columns for name and company name. Include paging in the RadGridView with 20 records per page."
+* "`@telerikwinforms` Create a line RadChartView with 100 records of sample data. Each record should have Value plotted on the vertical axis and Date on the horizontal axis."
+* "`@telerikwinforms` Show me how to size all columns in GridView to take all the available space."
+
+![WinForms AI Assistance Sample Prompt](images/copilot-extension001.png)
+
+>tip Visit the Telerik UI for WinForms Prompt Library for more sample prompts.
+
+## 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)

ai-coding-assistant/images/ai-mcp-server001.png

@@ -0,0 +1,160 @@
+---
+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@latest
+```
+
+### 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 | `telerik-winforms-mcp` (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"
+ }
+ ```
+
+The THE_PATH_TO_YOUR_LICENSE_FILE should point to the telerik-license.txt file, which is usually located in the AppData folder. So, the field often will look like this: "TELERIK_LICENSE_PATH": "%appdata%/Telerik/telerik-license.txt"
+
+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
+ {
+   "inputs": [],
+   "servers": {
+     "telerik-winforms-mcp": {
+       "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 `telerik-winforms-mcp` 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).
+
+![WinForms AI Assistance MCP Server](images/ai-mcp-server001.png)
+
+### Global Setup:
+
+Add the `.mcp.json` file to your user directory (`%USERPROFILE%`, e.g., `C:\Users\YourName\.mcp.json`).
+
+## Usage
+
+To use the Telerik MCP Server:
+
+1. Start your prompt with one of these triggers:
+   - `/telerik` / `@telerik` / `#telerik`
+   - `/telerikwinforms` / `@telerikwinforms` / `#telerikwinforms`
+   - `#telerik-winforms-mcp`
+
+2. Verify server activation by looking for these messages:
+   - Visual Studio: `Running telerik-winforms-mcp`
+   - Visual Studio Code: `Running telerik-winforms-assistant`
+   - Cursor: `Calling MCP tool telerik-winforms-mcp`
+
+3. Grant permissions when prompted (per session, workspace, or always).
+
+4. Start fresh sessions for unrelated prompts to avoid context pollution.
+
+You can check the Output pane of Visual Studio for diagnostics information related to Copilot. To display the relevant information, select to show output from GitHub Copilot.
+
+![WinForms AI Assistance MCP Server](images/ai-mcp-server002.png)
+
+### 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 RadGridView with sorting and paging. Bind it to a Person model with a sample ViewModel."
+* "`/telerikwinforms` Create a RadDropDownList showing a product list of 20 items. Include Product class and sample data."
+* "`/telerik` Build a RadListView 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%})