@progress/kendo-angular-mcp 0.1.0

package/README.md

@@ -0,0 +1,111 @@
+# Kendo UI for Angular MCP Server
+
+The Kendo UI for Angular [MCP Server](https://modelcontextprotocol.io/introduction) enables you achieve interation 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 Kendo UI for Angular MCP server to ask about Kendo UI for Angular components, features, or general usage. You can successfully prompt more complex questions and tasks, and generate tailored code that includes Kendo UI for Angular components and API.
+
+> **Disclaimer:**  
+> This version of the Kendo UI for Angular MCP Server is a **beta release**. Behavior may change before the final release.
+
+## Prerequisites
+
+To use the Kendo UI for Angular MCP server, you need:
+
+* A [compatible MCP client (IDE, code editor or app)](https://modelcontextprotocol.io/clients) that supports *MCP tools*.
+* A [Telerik user account](https://www.telerik.com/account/).
+* An active [DevCraft or Kendo UI for Angular license](https://www.telerik.com/purchase/kendo-ui) or a [Kendo UI for Angular trial](https://www.telerik.com/download).
+
+## Installation
+
+Use the documentation of your AI-powered MCP client to add the Kendo UI for Angular 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 Kendo UI for Angular MCP server are:
+
+* Server name: `kendo-angular-assistant`
+* Type: `stdio` (standard input/output transport)
+* Command: `npx` (the MCP server works through an npm package)
+* Supported arguments: `-y`
+* npm package name: `@progress/kendo-angular-mcp`
+* You also need to add your [Telerik licence key](https://www.telerik.com/kendo-angular-ui/components/licensing) 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](https://www.telerik.com/kendo-angular-ui/components/licensing) when necessary.
+
+## Authentication
+
+The MCP server requires a valid Telerik account with a valid license. In order to get a valid license key check the [Kendo UI for Angular documentation](https://www.telerik.com/kendo-angular-ui/components/licensing).
+
+To set up the license key, you need to set it up as an environment variable in the JSON configuration file.
+
+## Configuration Examples
+
+### VSCode - Copilot
+
+Refer to [Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
+
+To enable the Kendo UI for Angular MCP server in a specific workspace or Angular app, add a `.vscode` folder with an `mcp.json` file at the root of the workspace:
+
+> .vscode/mcp.json at the workspace root
+
+```json
+{
+  "servers": {
+    "kendo-angular-assistant": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "@progress/kendo-angular-mcp@latest"],
+      "env": {
+        "TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
+        // or
+        "TELERIK_LICENSE": "YOUR_LICENSE_KEY"
+      }
+    }
+  }
+}
+```
+
+### Cursor
+
+Refer to [Model Context Protocol](https://docs.cursor.com/context/model-context-protocol).
+
+To [enable the Kendo UI for Angular MCP server in a specific workspace](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server-to-your-workspace) or Angular app, add a `.cursor` folder with an `mcp.json` file at the root of the workspace.
+
+> .cursor/mcp.json at the workspace root
+
+```json
+{
+  "mcpServers": {
+    "kendo-angular-assistant": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "@progress/kendo-angular-mcp@latest"],
+      "env": {
+        "TELERIK_LICENSE_PATH": "THE_PATH_TO_YOUR_LICENSE_FILE",
+        // or
+        "TELERIK_LICENSE": "YOUR_LICENSE_KEY"
+      },
+    }
+  }
+}
+```
+
+## Usage
+
+To use the Kendo UI for Angular MCP server:
+
+1. Start your prompt with one of the following:
+    * `kendo`
+    * `/kendo`
+    * `@kendo`
+    * `kendoangular`
+    * `/kendoangular`
+    * `@kendoangular`
+
+   Or if you are using VSCode you can type `#kendo_angular_assistant` to make sure the Copilot chat will call the Kendo UI for Angular MCP server.
+   
+1. Confirm that the Kendo UI for Angular MCP server is used, because this doesn't happen deterministically. Look for a statement in the output, which is similar to:
+    * `Running kendo-angular-assistant` (in VS Code)
+    * `Calling MCP tool kendo-angular-assistant` (in Cursor)
+
+    If the Kendo UI for Angular 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 Kendo UI for Angular 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 Kendo UI for Angular 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).

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+var _=Object.defineProperty;var D=(e,r,o)=>r in e?_(e,r,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[r]=o;var d=(e,r,o)=>D(e,typeof r!="symbol"?r+"":r,o);import{McpServer as M}from"@modelcontextprotocol/sdk/server/mcp.js";import{StdioServerTransport as O}from"@modelcontextprotocol/sdk/server/stdio.js";import{z as C}from"zod";var h="Kendo UI for Angular",g="angular",S=["AIPrompt","ActionSheet","AppBar","ArcGauge","AutoComplete","Avatar","Badge","Barcode","BottomNavigation","BreadCrumb","Button","ButtonGroup","Calendar","Card","ChartWizard","Charts","CheckBox","Chip","ChipList","ChunkProgressBar","CircularGauge","CircularProgressBar","ColorGradient","ColorPalette","ColorPicker","ComboBox","ContextMenu","ConversationalUI","DataQuery","DateInput","DateMath","DatePicker","DateRange","DateTimePicker","Dialog","DragandDrop","Drawer","Drawing","DropDownButton","DropDownList","DropDownTree","Editor","ExcelExport","ExpansionPanel","FileSaver","FileSelect","Filter","FlatColorPicker","FloatingActionButton","FloatingLabel","Forms","FormField","Gantt","Gauges","General","Grid","GridLayout","Icon","Label","LinearGauge","ListBox","ListView","Loader","Map","MaskedTextBox","Menu","MultiColumnComboBox","MultiSelect","MultiSelectTree","MultiViewCalendar","Notification","NumericTextBox","OTPInput","Pager","PanelBar","PDFExport","PDFViewer","PivotGrid","Popover","Popup","ProgressBar","QRCode","RadialGauge","RadioButton","RangeSlider","Rating","Ripple","Sankey","Scheduler","ScrollView","Signature","Skeleton","Slider","Sortable","StockChart","Sparkline","SplitButton","Splitter","Spreadsheet","StackLayout","Stepper","SVGIcon","Switch","TabStrip","TextArea","TextBox","TileLayout","Timeline","TimePicker","ToolBar","Tooltip","TreeList","TreeView","Typography","Upload","Window"];import{dirname as R,join as B}from"path";import{fileURLToPath as G}from"url";import{readFileSync as L}from"node:fs";import a from"node:fs";import p from"node:path";import N from"@grpc/proto-loader";import l from"@grpc/grpc-js";var E=["TELERIK_LICENSE","KENDO_UI_LICENSE"],y="TELERIK_LICENSE_PATH",c=(e=>(e[e.UNAUTHENTICATED=16]="UNAUTHENTICATED",e[e.RESOURCE_EXHAUSTED=8]="RESOURCE_EXHAUSTED",e[e.PERMISSION_DENIED=7]="PERMISSION_DENIED",e))(c||{}),v=!1,i=process.env.DEBUG_LOG_FILE,x=!!(i&&typeof i=="string");if(x){let e=p.resolve(i),r=p.dirname(e);if(r!=="."&&r!==process.cwd()&&!a.existsSync(r))try{a.mkdirSync(r,{recursive:!0})}catch(o){console.error("Error creating log directory:",o)}if(!a.existsSync(e))try{a.writeFileSync(e,"")}catch(o){console.error("Error creating log file:",o)}}v=x&&!!i&&a.existsSync(p.resolve(i));function n(...e){if(v&&i){let r=`${new Date().toISOString()}: ${e.join(" ")}
+`,o=p.resolve(i);a.appendFile(o,r,t=>{t&&console.error("Error writing to log file:",t)})}}var s=process.env[y],m=process.env[E[0]]||process.env[E[1]],u=class extends Error{constructor(e){super(e),this.name="LicenseError"}};function U(){if(!s&&!m)throw new u(`No license found. Please set one of the following environment variables: ${E.join(", ")} or ${y}`);let e;if(s)try{e=L(s,"utf8"),n("License key read from file: ",s)}catch{throw new u(`Error reading license file: ${s}. Please verify the file exists and is readable.`)}return m&&(e=m,n("License key read from environment variable.")),e}var A=class{constructor(e,r){d(this,"client");d(this,"isDev");this.contextApiUrl=e,this.protoPath=r;let o=N.loadSync(this.protoPath,{keepCase:!0,longs:String,enums:String,defaults:!0,oneofs:!0});this.isDev=this.contextApiUrl?.includes("localhost")||this.contextApiUrl?.includes("127.0.0.1"),n("Using ContextApi URl:",this.contextApiUrl);let t=l.loadPackageDefinition(o);this.client=new t.ContextQueryService(this.contextApiUrl||"contextapi.telerik.com:443",this.isDev?l.credentials.createInsecure():l.credentials.createSsl())}async query(e){let r=this.isDev?"fake_license":U(),o=new l.Metadata;if(r&&typeof r=="string"){r=r.replace(/^\uFEFF/,"");try{o.add("x-license-key",r)}catch(t){return n("Error adding license key to metadata:",t),Promise.reject(new Error(`Failed to use license key: ${t.message}`))}}return r&&typeof r=="string"&&o.add("x-license-key",r),new Promise((t,P)=>{this.client.query(e,o,(f,I)=>{f?P(f):t(I)})})}};var F=B(R(G(import.meta.url)),"../proto/service.proto"),b=new A("staging.contextapi.telerik.com:443",F);async function w(e){return b.query(e)}import q from"fs";import k from"path";import{fileURLToPath as V}from"url";var $=V(import.meta.url),H=k.dirname($),K=k.resolve(H,"../package.json"),j=JSON.parse(q.readFileSync(K,"utf-8")),T=new M({name:"kendo-and-kendo-resources",version:j.version});T.tool("kendo_angular_assistant",`Answers questions and retrieves documentation about Kendo UI for Angular. 
+Use this tool when the user asks about Kendo UI for Angular features, specific components (e.g., Grid, Charts, Editor), implementation details, or general usage. 
+Provide the user's detailed question as the 'query'. If the question pertains to a specific Kendo UI for Angular component, 
+specify its name in the 'component' parameter. This tool can be automatically triggered when the following phrases are detected in the user's input/prompt:
+- 'kendo';
+- '/kendo';
+- '/kendoangular'
+- '/ask_kendo';
+- '/help_kendo';
+- '@kendo';
+- '@kendoangular';
+- '@ask_kendo';
+- '@help_kendo'.`,{query:C.string().describe("The query to search for."),component:C.enum(S).describe("The component to search for. If not specified, you can use General.")},async({query:e,component:r})=>{n("Calling tool: ",JSON.stringify({query:e,component:r}));try{let t=[{type:"text",text:(await w({query:e,component:r.toLocaleLowerCase(),lib_name:g,text_matches_count:3,code_matches_count:0,allowed_types:["documentation"]})).values.join(`
+
+`)}];return n("Response from tool: ",JSON.stringify(t)),{content:t}}catch(o){throw n("Error calling context API: ",JSON.stringify(o)),o?.code===c.UNAUTHENTICATED?new Error("Error: You are not authenticated. Please verify the Telerik License Key provided is valid."):o?.code===c.RESOURCE_EXHAUSTED?new Error(`Error: You have exceeded the extension quota. Upgrade to subscription licensing in order to unlock full access. Message: ${o.message}.`):o?.code===c.PERMISSION_DENIED?new Error(`Error: You do not have permission to access this resource. Please verify that you have a valid ${h} license key.`):o instanceof u?(n("License error: ",o.message),o):new Error(`Error: An error occurred while calling the service. Please try again later.
+
+Error Message: ${o.message}`)}});async function J(){let e=new O;n("Starting server..."),await T.connect(e)}J();

package/dist/lib/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const ANGULAR_SUITE_NAME = "Kendo UI for Angular";
+export declare const Suite = "angular";
+export declare const AngularComponents: readonly ["AIPrompt", "ActionSheet", "AppBar", "ArcGauge", "AutoComplete", "Avatar", "Badge", "Barcode", "BottomNavigation", "BreadCrumb", "Button", "ButtonGroup", "Calendar", "Card", "ChartWizard", "Charts", "CheckBox", "Chip", "ChipList", "ChunkProgressBar", "CircularGauge", "CircularProgressBar", "ColorGradient", "ColorPalette", "ColorPicker", "ComboBox", "ContextMenu", "ConversationalUI", "DataQuery", "DateInput", "DateMath", "DatePicker", "DateRange", "DateTimePicker", "Dialog", "DragandDrop", "Drawer", "Drawing", "DropDownButton", "DropDownList", "DropDownTree", "Editor", "ExcelExport", "ExpansionPanel", "FileSaver", "FileSelect", "Filter", "FlatColorPicker", "FloatingActionButton", "FloatingLabel", "Forms", "FormField", "Gantt", "Gauges", "General", "Grid", "GridLayout", "Icon", "Label", "LinearGauge", "ListBox", "ListView", "Loader", "Map", "MaskedTextBox", "Menu", "MultiColumnComboBox", "MultiSelect", "MultiSelectTree", "MultiViewCalendar", "Notification", "NumericTextBox", "OTPInput", "Pager", "PanelBar", "PDFExport", "PDFViewer", "PivotGrid", "Popover", "Popup", "ProgressBar", "QRCode", "RadialGauge", "RadioButton", "RangeSlider", "Rating", "Ripple", "Sankey", "Scheduler", "ScrollView", "Signature", "Skeleton", "Slider", "Sortable", "StockChart", "Sparkline", "SplitButton", "Splitter", "Spreadsheet", "StackLayout", "Stepper", "SVGIcon", "Switch", "TabStrip", "TextArea", "TextBox", "TileLayout", "Timeline", "TimePicker", "ToolBar", "Tooltip", "TreeList", "TreeView", "Typography", "Upload", "Window"];

package/dist/lib/grpc-client.d.ts

@@ -0,0 +1,3 @@
+export declare function query(queryParams: any): Promise<{
+    values: string[];
+}>;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@progress/kendo-angular-mcp",
+  "version": "0.1.0",
+  "type": "module",
+  "bin": "./dist/index.js",
+  "license": "See LICENSE.md",
+  "description": "Model Context Protocol for Kendo UI for Angular",
+  "keywords": [
+    "MCP Server",
+    "Model Context Protocol",
+    "Angular",
+    "Kendo",
+    "Progress",
+    "AI",
+    "Copilot",
+    "Kendo UI for Angular"
+  ],
+  "files": [
+    "dist",
+    "proto",
+    "README.md",
+    "LICENSE.md",
+    "!**/*.tsbuildinfo"
+  ],
+  "dependencies": {
+    "@grpc/grpc-js": "^1.13.3",
+    "@grpc/proto-loader": "^0.7.15",
+    "@modelcontextprotocol/sdk": "^1.8.0",
+    "tslib": "^2.3.0",
+    "@local/mcp-common": "*"
+  }
+}

package/proto/service.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+option go_package = "github.com/telerik/ai-builder/contextapi/pkg/api/pb";
+
+
+message ContextQueryRequest {
+    string lib_name = 1;
+    string query = 2;
+    int32 text_matches_count = 3;
+    int32 code_matches_count = 4;
+    repeated string allowed_types = 5;
+    string component = 6;
+}
+
+message Item {
+    map<string, string> metadata = 1;
+    string content = 2;
+}
+
+message ContextQueryResponse {
+    repeated Item text = 1;
+    repeated Item code = 2;
+}
+
+message StringArray {
+    repeated string values = 1;
+}
+
+service ContextQueryService {
+    rpc Query(ContextQueryRequest) returns (StringArray);
+}