@progress/kendo-react-mcp 1.4.2 → 1.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -47
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# KendoReact MCP Server
|
|
2
2
|
|
|
3
|
-
The
|
|
3
|
+
The KendoReact [MCP Server](https://modelcontextprotocol.io/introduction) enables you to achieve integration with your already existing AI workflows and reach new levels of developer productivity. The MCP server provides proprietary context to AI-powered IDEs, apps and tools. You can use the KendoReact MCP Server to ask about KendoReact components, features, or general usage. You can successfully prompt more complex questions and tasks, and generate tailored code that includes KendoReact components and API.
|
|
4
4
|
|
|
5
|
-
As of version 1.4 the
|
|
5
|
+
As of version 1.4 the KendoReact MCP server supports [two modes of operation](https://www.telerik.com/kendo-react-ui/components/ai-tools#ai-tools-overview-and-comparison) that depends on your [Telerik license type](https://www.telerik.com/purchase/faq/licensing-purchasing):
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
* **Initial code generation**: Quickly add components to your app to speed up the initial development.
|
|
10
|
-
* **Component configuration**: Enable or disable specific component features, or fine tune the configuration through prompting. More * complex configurations are possible but may require additional manual work to be production-ready.
|
|
11
|
-
* **Dummy data generation and data binding**: Quickly add data to your app for testing and prototyping purposes. Avoid exposing or providing access to your proprietary or production data to AI-enabled tools.
|
|
12
|
-
* **Step-by-step explanations**: Understand the solutions provided by the AI Coding Assistant through the detailed explanations (depends * on the tool, mode, and model used). To further develop your knowledge, check the respective documentation.
|
|
13
|
-
* **Preliminary troubleshooting**: Resolve obvious and easy-to-solve issues affecting your code. For more complex issues, look for assistance from the community or contact the support team.
|
|
7
|
+
* **Agentic UI Generator**—Includes all four specialized tools (Component, Layout, Styling, and Icon), coordinated by a comprehensive orchestrator designed for complete UI generation.
|
|
8
|
+
* **AI Coding Assistant**—Includes the Component Tool and Icon Tool, coordinated by an orchestrator optimized for component-level development.
|
|
14
9
|
|
|
15
10
|
## **Agentic UI Generator** Intended Use
|
|
16
11
|
|
|
17
|
-
* **Create Individual Components**: Build specific
|
|
12
|
+
* **Create Individual Components**: Build specific KendoReact components with particular configurations and features like filtering, validation, and data binding.
|
|
18
13
|
* **Create Full Responsive Pages**
|
|
19
14
|
* Build complete dashboards, landing pages, and listing pages in existing applications.
|
|
20
15
|
* Generate pages similar to the [Progress Design System page templates](https://www.telerik.com/design-system/docs/ui-templates/overview/).
|
|
@@ -23,19 +18,26 @@ As of version 1.4 the Kendo UI for React MCP server supports two modes of operat
|
|
|
23
18
|
* Create new responsive pages and sections.
|
|
24
19
|
* Convert existing pages to be responsive for mobile and tablet views.
|
|
25
20
|
|
|
21
|
+
## **AI Coding Assistant** Intended Use
|
|
22
|
+
|
|
23
|
+
* **Initial code generation**: Quickly add components to your app to speed up the initial development.
|
|
24
|
+
* **Component configuration**: Enable or disable specific component features, or fine tune the configuration through prompting. More * complex configurations are possible but may require additional manual work to be production-ready.
|
|
25
|
+
* **Dummy data generation and data binding**: Quickly add data to your app for testing and prototyping purposes. Avoid exposing or providing access to your proprietary or production data to AI-enabled tools.
|
|
26
|
+
* **Step-by-step explanations**: Understand the solutions provided by the AI Coding Assistant through the detailed explanations (depends * on the tool, mode, and model used). To further develop your knowledge, check the respective documentation.
|
|
27
|
+
* **Preliminary troubleshooting**: Resolve obvious and easy-to-solve issues affecting your code. For more complex issues, look for assistance from the community or contact the support team.
|
|
28
|
+
|
|
26
29
|
## Prerequisites
|
|
27
30
|
|
|
28
|
-
To use the
|
|
31
|
+
To use the KendoReact MCP Server, you need:
|
|
29
32
|
|
|
30
33
|
* A [compatible MCP client (IDE, code editor or app)](https://modelcontextprotocol.io/clients) that supports *MCP tools*.
|
|
31
|
-
*
|
|
32
|
-
* An active [DevCraft or Kendo UI for React license](https://www.telerik.com/kendo-react-ui/pricing) or a [Kendo UI for React trial](https://www.telerik.com/kendo-react-ui).
|
|
34
|
+
* An active [Telerik license](https://www.telerik.com/kendo-react-ui/components/ai-tools#license-requirements) that provides access to the KendoReact MCP server.
|
|
33
35
|
|
|
34
36
|
## Installation
|
|
35
37
|
|
|
36
|
-
Use the documentation of your AI-powered MCP client to add the
|
|
38
|
+
Use the documentation of your AI-powered MCP client to add the KendoReact MCP server to a specific workspace or globally. You can see installation tips and examples for some popular MCP clients below.
|
|
37
39
|
|
|
38
|
-
The generic settings of the
|
|
40
|
+
The generic settings of the KendoReact MCP Server are:
|
|
39
41
|
|
|
40
42
|
* Server name: `kendo-mcp`
|
|
41
43
|
* Type: `stdio` (standard input/output transport)
|
|
@@ -50,9 +52,14 @@ The generic settings of the Kendo UI for React MCP Server are:
|
|
|
50
52
|
|
|
51
53
|
## Authentication
|
|
52
54
|
|
|
53
|
-
The MCP server requires
|
|
55
|
+
The KendoReact MCP server [requires an active Subscription or trial license](https://www.telerik.com/kendo-react-ui/components/ai-tools#license-requirements) and a valid key for authentication. You can configure your license key either globally on your machine or locally in the `mcp.json` configuration file.
|
|
54
56
|
|
|
55
|
-
|
|
57
|
+
- *(Recommended)* When set globally, the MCP server automatically recognizes the license and you can ignore the `env` parameter in the `mcp.json` setup.
|
|
58
|
+
- When configured locally, you have to define either one of the following variables inside the `mcp.json` file:
|
|
59
|
+
* `TELERIK_LICENSE_PATH`—to point to your license file location.
|
|
60
|
+
* `TELERIK_LICENSE`—to paste your license key directly.
|
|
61
|
+
|
|
62
|
+
For detailed instructions on obtaining and managing your license key, see [KendoReact Licensing](https://www.telerik.com/kendo-react-ui/components/my-license).
|
|
56
63
|
|
|
57
64
|
## Configuration Examples
|
|
58
65
|
|
|
@@ -87,7 +94,7 @@ To enable the Kendo React MCP server in a specific workspace or React app, add a
|
|
|
87
94
|
|
|
88
95
|
Refer to [Model Context Protocol](https://docs.cursor.com/context/model-context-protocol).
|
|
89
96
|
|
|
90
|
-
To [enable the
|
|
97
|
+
To [enable the KendoReact MCP server in a specific workspace](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server-to-your-workspace) or React app, add a `.cursor` folder with an `mcp.json` file at the root of the workspace.
|
|
91
98
|
|
|
92
99
|
> .cursor/mcp.json at the workspace root
|
|
93
100
|
|
|
@@ -112,8 +119,25 @@ To [enable the Kendo UI for React MCP server in a specific workspace](https://c
|
|
|
112
119
|
|
|
113
120
|
## Usage
|
|
114
121
|
|
|
115
|
-
To increase the probability of the
|
|
122
|
+
To increase the probability of the KendoReact MCP Server being used, or to call it without the need to mention "kendo" explicitly, add custom idea instructions to your AI-powered tool. Here are examples for [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot#about-repository-custom-instructions-for-github-copilot-chat) and [Cursor](https://docs.cursor.com/context/rules).
|
|
123
|
+
|
|
124
|
+
### Agentic UI Generator
|
|
125
|
+
|
|
126
|
+
To use the Agentic UI Generator mode:
|
|
127
|
+
|
|
128
|
+
1. Open the AI chat interface in your IDE—Start a new chat session to begin interacting with the Agentic UI Generator.
|
|
129
|
+
1. Start your prompt with `#kendo_ui_generator` (the main MCP tool to start the agentic workflow in the Agentic UI Generator).
|
|
130
|
+
1. This will trigger an agentic workflow using the other available MCP tools to retrieve relevant context based on your prompt.
|
|
131
|
+
1. Inspect the output and verify that the KendoReact MCP Server is used. Look for a statement in the output, which is similar to:
|
|
132
|
+
* `Running kendo-mcp-server` (in VS Code)
|
|
133
|
+
* `Calling MCP tool kendo-mcp-server` (in Cursor)
|
|
134
|
+
1. If requested, grant the KendoReact MCP server a permission to run for this session, workspace, or always.
|
|
116
135
|
|
|
136
|
+
Also check more usefule documentation about how to use the Agentic UI Generator here:
|
|
137
|
+
- [Getting Started](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator/getting-started)
|
|
138
|
+
- [Use Cases](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator/getting-started#use-cases)
|
|
139
|
+
- [Best Practices](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator/getting-started#best-practices) for more usage tips.
|
|
140
|
+
- [Prompt Library](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator/prompt-library)
|
|
117
141
|
|
|
118
142
|
### AI Coding Assistant
|
|
119
143
|
|
|
@@ -121,38 +145,20 @@ To use the AI Coding Assistant mode:
|
|
|
121
145
|
|
|
122
146
|
1. Start your prompt with `#kendo_react_assistant` (the main MCP tool to start the agentic workflow in the coding agent).
|
|
123
147
|
1. This will trigger an agentic workflow using the other available MCP tools to retrieve relevant context based on your prompt.
|
|
124
|
-
1. Inspect the output and verify that the
|
|
148
|
+
1. Inspect the output and verify that the KendoReact MCP Server is used. Look for a statement in the output, which is similar to:
|
|
125
149
|
* `Running kendo-react-mcp-server` (in VS Code)
|
|
126
150
|
* `Calling MCP tool kendo-react-mcp-server` (in Cursor)
|
|
127
151
|
|
|
128
|
-
If the
|
|
129
|
-
1. If requested, grant the
|
|
152
|
+
If the KendoReact MCP server is not used even though it's installed and enabled, double-check the server name in your configuration and try rephrasing your prompt.
|
|
153
|
+
1. If requested, grant the KendoReact MCP server a permission to run for this session, workspace, or always.
|
|
130
154
|
|
|
131
155
|
Also check more useful documentation about how to use the AI Coding Assistant here:
|
|
132
|
-
- [Getting Started](https://www.telerik.com/kendo-react-ui/components/ai-tools/ai-assistant
|
|
133
|
-
- [
|
|
156
|
+
- [Getting Started](https://www.telerik.com/kendo-react-ui/components/ai-tools/ai-assistant/getting-started)
|
|
157
|
+
- [Use Cases](https://www.telerik.com/kendo-react-ui/components/ai-tools/ai-assistant/getting-started#use-cases)
|
|
158
|
+
- [Best Practices](https://www.telerik.com/kendo-react-ui/components/ai-tools/ai-assistant/getting-started#best-practices)
|
|
134
159
|
- [Prompt Library](https://www.telerik.com/kendo-react-ui/components/ai-tools/ai-assistant/prompt-library)
|
|
135
160
|
|
|
136
|
-
### Agentic UI Generator
|
|
137
|
-
|
|
138
|
-
To use the Agentic UI Generator mode:
|
|
139
|
-
|
|
140
|
-
1. Open the AI chat interface in your IDE—Start a new chat session to begin interacting with the Agentic UI Generator.
|
|
141
|
-
1. Start your prompt with `#kendo_ui_generator` (the main MCP tool to start the agentic workflow in the Agentic UI Generator).
|
|
142
|
-
1. This will trigger an agentic workflow using the other available MCP tools to retrieve relevant context based on your prompt.
|
|
143
|
-
1. Inspect the output and verify that the Kendo UI for React MCP Server is used. Look for a statement in the output, which is similar to:
|
|
144
|
-
* `Running kendo-mcp-server` (in VS Code)
|
|
145
|
-
* `Calling MCP tool kendo-mcp-server` (in Cursor)
|
|
146
|
-
1. If requested, grant the Kendo UI for React MCP server a permission to run for this session, workspace, or always.
|
|
147
|
-
|
|
148
|
-
Also check more usefule documentation about how to use the Agentic UI Generator here:
|
|
149
|
-
- [Getting Started](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator#getting-started)
|
|
150
|
-
- [Intended Use](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator#intended-use)
|
|
151
|
-
- [Recommendations](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator#recommendations) for more usage tips.
|
|
152
|
-
- [Prompt Library](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator/prompt-library#kendoreact-agentic-ui-generator-prompt-library)
|
|
153
|
-
|
|
154
161
|
### AI Tools Usage
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
- [
|
|
158
|
-
- [Agentic UI Generator - Usage Limits](https://www.telerik.com/kendo-react-ui/components/ai-tools/agentic-ui-generator#usage-limits)
|
|
162
|
+
Access to the KendoReact AI Tools is determined by your [Telerik license type](https://www.telerik.com/purchase.aspx?filter=web). Each license tier provides different levels of access and functionality:
|
|
163
|
+
- [License Requirements](https://www.telerik.com/kendo-react-ui/components/ai-tools#license-requirements)
|
|
164
|
+
- [Usage Limits](https://www.telerik.com/kendo-react-ui/components/ai-tools#usage-limits)
|