Model Context Protocol for Telerik UI for WinForms
npm install @progress/telerik-winforms-mcpThe Telerik UI for WinForms MCP Server enables you achieve interaction with AI and reach new levels of developer productivity. The MCP server provides proprietary context to AI-powered IDEs, apps and tools. You can use the Telerik UI for WinForms MCP server to ask about Telerik UI for WinForms components, features, or general usage. You can successfully prompt more complex questions and tasks, and generate tailored code that includes Telerik UI for WinForms components and API.
To use the Telerik UI for WinForms MCP server, you need:
A compatible MCP client (IDE, code editor or app) that supports MCP tools*.
* A Telerik user account.
* An active DevCraft or Telerik UI for WinForms license or a Telerik UI for WinForms trial.
Use the documentation of your AI-powered MCP client to add the Telerik UI for WinForms MCP server to a specific workspace or globally. You can see installation tips and examples for some popular MCP clients below.
The generic settings of the Telerik UI for WinForms MCP server are:
* Server name: telerik-winforms-assistant
* Type: stdio (standard input/output transport)
* Command: npx (the MCP server works through an npm package)
* Supported arguments: -y
* npm package name: @progress/telerik-winforms-mcp
* You also need to add your Telerik licence key as an env parameter in the mcp.json file. There are two options:
* (recommended) Use a TELERIK_LICENSE_PATH argument and point to your Telerik license file location.
* Use a TELERIK_LICENSE argument and paste your Telerik license key. Make sure to update the license key when necessary.
The MCP server requires a valid Telerik account with a valid license. In order to get a valid license key check the Telerik UI for WinForms documentation.
To set up the license key, you need to set it up as an environment variable in the JSON configuration file.
Refer to Use MCP servers in Visual Studio.
To enable the Telerik MCP Server in a specific WinForms app, add a .mcp.json file to the solution folder.
> SOLUTIONDIR/.mcp.json
``json`
{
"servers": {
"telerikWinFormsАssistant": {
"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"
}
}
}
}
* Avoid using hyphens "-" or underscores "_" in the MCP server name in the MCP .json file, due to potential compatibility issues with some MCP clients such as Visual Studio.
* Once the Telerik MCP server is added, make sure that the telerikWinFormsAssistant tool is enabled (checked) in the Copilot Chat window's tool selection dropdown in Visual Studio.
`
To use the Telerik UI for WinForms MCP server:
1. Start your prompt with one of the following:
* telerik
*
*
*
*
*
Or if you are using VSCode you can type #telerik-winforms-assistant to make sure the Copilot chat will call the Telerik UI for WinForms MCP server.
1. Confirm that the Telerik UI for WinForms MCP server is used, because this doesn't happen deterministically. Look for a statement in the output, which is similar to:
* Running telerik-winforms-assistant` (in Visual Studio)
If the Telerik UI for WinForms MCP server is not used even though it's installed and enabled, then try rephrasing your prompt and use another trigger syntax from the list in step 1.
1. Grant the Telerik UI for WinForms MCP server a permission to run for this session, workspace, or always.
1. If you want to prompt for information or code that are not related to your previous prompts, it is a good practice to start a new session in a new chat window, so that the context is not polluted by irrelevant old information.
To increase the probability of the Telerik UI for WinForms MCP Server being used, or to call it without the need to mention "telerik" explicitly, add custom idea instructions to your AI-powered tool. Here are examples for GitHub Copilot.