@syncfusion/javascript-assistant 0.1.0 → 1.0.0

package/README.md

@@ -1,203 +1,231 @@
-# SyncfusionJavaScriptAssistant MCP Server
-
-## Overview
-
-The SyncfusionJavaScriptAssistant is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server designed to enhance development with Syncfusion's Javascript control libraries. It integrates seamlessly with [MCP-compatible clients](https://modelcontextprotocol.io/clients) to provide intelligent assistance for building Javascript applications with Syncfusion<sup style="font-size:70%">&reg;</sup> controls.
-
-### Key Features
-
-* Intelligent code generation for Syncfusion<sup style="font-size:70%">&reg;</sup> Javascript controls.
-* Detailed control documentation and usage examples.
-* Troubleshooting assistance for common integration challenges.
-
-## Prerequisites
-
-Before using SyncfusionJavaScriptAssistant, ensure you have:
-
-* Required [node](https://nodejs.org/en/) version >= 18
-* A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion<sup style="font-size:70%">&reg;</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.)
-* An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
-  - [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
-  - [Free Community License](https://www.syncfusion.com/products/communitylicense)
-  - [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)
-* An active [API KEY](https://syncfusion.com/account/api-key)
-
-## Unlimited Access
-
-Syncfusion<sup style="font-size:70%">&reg;</sup> offers unlimited access to this MCP server. There are no restrictions on:
-
-* Number of requests
-* Controls usage
-* Query caps
-* Usage duration
-
-This ensures users can fully leverage Syncfusion<sup style="font-size:70%">&reg;</sup> controls to enhance their development experience without limitations.
-
-## Installation
-
-Before you can invoke the `SyncfusionJavaScriptAssistant` MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients:
-
-### Generic MCP Server Settings
-
-- **npm package name**: `@syncfusion/javascript-assistant`
-- **Type**: stdio (standard input/output transport)
-- **Command**: npx
-- **Arguments**: -y
-- **Server name**: SyncfusionJavaScriptAssistant
-
-You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
-
-```json
-"env": {
-  "Syncfusion_API_Key": "YOUR_API_KEY"
-}
-```
-
-SyncfusionJavaScriptAssistant can be configured in various MCP clients. Below are setup instructions for popular environment:
-
-### Syncfusion<sup style="font-size:70%">&reg;</sup> Code Studio
-
-* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace, find `SyncfusionJavaScriptAssistant`, and click Install.
-* When prompted, enter your [Syncfusion API key](https://syncfusion.com/account/api-key) and click Submit to register.
-* It installs locally on your machine and appears in the Installed list.
-* The server is now ready for use in Code Studio. For more details, refer to the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/marketplace).
-
-### VS Code (GitHub Copilot MCP)
-
-1. To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder.
-
-```json
-{
-  "servers": {
-    "syncfusion-javascript-assistant": {
-      "type": "stdio",
-      "command": "npx",
-      "args": [
-        "-y",
-        "@syncfusion/javascript-assistant@latest"
-      ],
-      "env": {
-        "Syncfusion_API_Key": "YOUR_API_KEY"
-      }
-    }
-  }
-}
-```
-
-2. After updating the configuration in mcp.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the SyncfusionJavaScriptAssistant server directly from the settings interface without additional commands.
-
-3. Confirm that SyncfusionJavaScriptAssistant is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
-    * `SyncfusionJavaScriptAssistant is running...` (in VS Code)
-
-### Cursor
-
-To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder.
-
-```json
-{
-  "mcpServers": {
-    "syncfusion-javascript-assistant": {
-      "type": "stdio",
-      "command": "npx",
-      "args": [
-        "-y",
-        "@syncfusion/javascript-assistant@latest"
-      ],
-      "env": {
-       "Syncfusion_API_Key": "YOUR_API_KEY"
-      }
-    }
-  }
-}
-```
-
-### JetBrains IDEs
-
-1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
-2. Click + Add to add a new MCP server configuration.
-3. In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config:
-
-```json
-{
-  "mcpServers": {
-    "syncfusion-javascript-assistant": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@syncfusion/javascript-assistant@latest"
-      ],
-      "env": {
-       "Syncfusion_API_Key": "YOUR_API_KEY"
-      }
-    }
-  }
-}
-```
-
-4. Click OK and Apply.
-
-For additional configuration details, refer to:
-  * [VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server)
-  * [Cursor](https://docs.cursor.com/en/context/mcp#using-mcp-json)
-  * [JetBrains](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server)
-  * [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json)
-
-## Usage
-
-To activate the SyncfusionJavaScriptAssistant MCP server:
-
-1. Start your prompt with one of the following:
-    * 'SyncfusionJavaScriptAssistant'
-    * '/syncfusion-javascript-assistant'
-    * '/syncfusion-javascript'
-    * '@syncfusion-javascript'
-    * '@ask_syncfusion_javascript'
-    * 'ej2-javascript'
-
-   In VS Code, you can also use #SyncfusionJavaScriptAssistant to explicitly invoke the MCP server.
-
-2. Grant the SyncfusionJavaScriptAssistant MCP server a permission to run for this session, workspace, or always.
-3. For best results, start a new chat for each new topic to maintain clean context.
-
-### Mode availability
-
-Syncfusion<sup style="font-size:70%">&reg;</sup> MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients.
-
-### Best Practices for Effective Usage
-
-1. `Be specific`: Mention both platform and control (e.g., "How do I create a Syncfusion JavaScript Grid with paging and filtering?").
-2. `Provide context`: Include details about your use case for more targeted solutions.
-3. `Use descriptive queries`: Avoid vague questions that lack necessary context.
-4. `Start fresh for new topics`: Begin a new chat session when switching controls or topics.
-
-### Example Queries
-
-Here are some effective ways to use SyncfusionJavaScriptAssistant:
-
- * "Create a Syncfusion JavaScript Grid control with paging, sorting and filtering."
- * "How do I implement data binding with Syncfusion JavaScript scheduler?"
- * "Show me how to create a dashboard with multiple Syncfusion controls"
-
-## Troubleshooting
-
-If you encounter issues:
-
- * Verify your API key is correctly configured.
- * Ensure the MCP server is enabled in your client's tools selection.
- * Check that you're using a compatible MCP client version.
- * Try restarting your development environment.
-
-## Support
-
-Product support is available through the following mediums.
-
-* [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
-* [Community forum](https://www.syncfusion.com/forums/essential-js2)
-* [Request feature or report bug](https://www.syncfusion.com/feedback/javascript)
-* Live chat
-
-## License
- This is a commercial product and requires a paid license for possession or use. Syncfusion<sup>®</sup> licensed software, including this control, is subject to the terms and conditions of [Syncfusion's EULA](https://www.syncfusion.com/eula/es/). To acquire a license, you can purchase [here](https://www.syncfusion.com/sales/products) or start a free 30-day trial [here](https://www.syncfusion.com/account/manage-trials/start-trials).
- A free [community license](https://www.syncfusion.com/products/communitylicense) is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.
-     © Copyright 2025 Syncfusion<sup>®</sup> Inc. All Rights Reserved. The Syncfusion<sup>®</sup> Essential Studio<sup>®</sup> license and copyright applies to this distribution.
-    The Syncfusion<sup>®</sup> Essential<sup>®</sup> Studio license and copyright applies to this distribution.
+# SyncfusionJavaScriptAssistant MCP Server
+
+## Overview
+
+The SyncfusionJavaScriptAssistant is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server designed to enhance development with Syncfusion's Javascript control libraries. It integrates seamlessly with [MCP-compatible clients](https://modelcontextprotocol.io/clients) to provide intelligent assistance for building Javascript applications with Syncfusion<sup style="font-size:70%">&reg;</sup> controls.
+
+### Key Features
+
+* Intelligent code generation for Syncfusion<sup style="font-size:70%">&reg;</sup> Javascript controls.
+* Detailed control documentation and usage examples.
+* Troubleshooting assistance for common integration challenges.
+
+## Prerequisites
+
+Before using SyncfusionJavaScriptAssistant, ensure you have:
+
+* Required [node](https://nodejs.org/en/) version >= 18
+* A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion<sup style="font-size:70%">&reg;</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.)
+* An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
+  - [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
+  - [Free Community License](https://www.syncfusion.com/products/communitylicense)
+  - [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)
+* An active [API KEY](https://syncfusion.com/account/api-key)
+
+## Unlimited Access
+
+Syncfusion<sup style="font-size:70%">&reg;</sup> offers unlimited access to this MCP server. There are no restrictions on:
+
+* Number of requests
+* Controls usage
+* Query caps
+* Usage duration
+
+This ensures users can fully leverage Syncfusion<sup style="font-size:70%">&reg;</sup> controls to enhance their development experience without limitations.
+
+## Installation
+
+Before you can invoke the `SyncfusionJavaScriptAssistant` MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients:
+
+### Generic MCP Server Settings
+
+- **npm package name**: `@syncfusion/javascript-assistant`
+- **Type**: stdio (standard input/output transport)
+- **Command**: npx
+- **Arguments**: -y
+- **Server name**: SyncfusionJavaScriptAssistant
+
+#### API Key Configuration
+
+Login to your [Syncfusion account](http://syncfusion.com/account/) and generate an API Key from the [API Key page](https://www.syncfusion.com/account/api-key). Replace `YOUR_API_KEY_FILE_PATH` or `YOUR_API_KEY` in the configuration files with your generated key.
+
+There are two options:
+
+* **Using an API Key File (Recommended)**
+
+  Store your API key in a separate file and reference its path in the `Syncfusion_API_Key_Path` environment parameter. This approach is more secure as you don't expose the key directly in configuration files.
+
+  **Supported file formats:** `.txt` or `.key` file
+
+  ```json
+  "env": {
+    "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
+  }
+  ```
+
+* **Direct API Key**
+
+  Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter.
+
+  ```json
+  "env": {
+    "Syncfusion_API_Key": "YOUR_API_KEY"
+  }
+  ```
+
+Below are setup instructions for popular MCP clients:
+
+### Syncfusion<sup style="font-size:70%">&reg;</sup> Code Studio
+
+* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the `Custom Servers` tab.
+* Enter the Server Name as `javascript-mcp`, choose Server Type as npm package, and set the NPM Package name to `@syncfusion/javascript-assistant`.
+* Add an environment variable as `Syncfusion_API_Key` and value as your [Syncfusion API key](https://syncfusion.com/account/api-key), then click **Install Server**.
+* Once installed, the server will appear in the User Installed Server list, and will be added to the **config.yaml** file.
+* The server is now ready for use in Code Studio. For more details, refer to the [Code Studio documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers#npm-server).
+
+### VS Code (GitHub Copilot MCP)
+
+* To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder.
+
+```json
+{
+  "servers": {
+    "syncfusion-javascript-assistant": {
+      "type": "stdio",
+      "command": "npx",
+      "args": [
+        "-y",
+        "@syncfusion/javascript-assistant@latest"
+      ],
+      "env": {
+        "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
+        "Syncfusion_API_Key": "YOUR_API_KEY"
+      }
+    }
+  }
+}
+```
+
+* After updating the configuration in mcp.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the SyncfusionJavaScriptAssistant server directly from the settings interface without additional commands.
+
+* Confirm the server is active by checking for a message like: `SyncfusionJavaScriptAssistant is running...` in the output.
+
+* For additional guidance, refer to the [VS Code documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server).
+
+### Cursor
+
+To configure an MCP server for a specific workspace, you can create a `.cursor/mcp.json` file in your workspace folder.
+
+```json
+{
+  "mcpServers": {
+    "syncfusion-javascript-assistant": {
+      "type": "stdio",
+      "command": "npx",
+      "args": [
+        "-y",
+        "@syncfusion/javascript-assistant@latest"
+      ],
+      "env": {
+       "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
+       "Syncfusion_API_Key": "YOUR_API_KEY"
+      }
+    }
+  }
+}
+```
+
+For more details, refer to the [Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-json).
+
+### JetBrains IDEs
+
+* Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
+* Click + Add to add a new MCP server configuration.
+* In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config:
+
+```json
+{
+  "mcpServers": {
+    "syncfusion-javascript-assistant": {
+      "command": "npx.cmd",
+      "args": [
+        "-y",
+        "@syncfusion/javascript-assistant@latest"
+      ],
+      "env": {
+       "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
+       "Syncfusion_API_Key": "YOUR_API_KEY"
+      }
+    }
+  }
+}
+```
+
+* Click OK and Apply.
+
+For further assistance, see the [JetBrains documentation](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server).
+
+> For more detailed information about configuring MCP servers in various clients, refer to the official documentations, e.g., [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json)
+
+## Usage
+
+To activate the SyncfusionJavaScriptAssistant MCP server:
+
+1. Start your prompt with one of the following:
+    * 'SyncfusionJavaScriptAssistant'
+    * '/syncfusion-javascript-assistant'
+    * '/syncfusion-javascript'
+    * '@syncfusion-javascript'
+    * '@ask_syncfusion_javascript'
+    * 'ej2-javascript'
+
+   In VS Code, use `#SyncfusionJavaScriptAssistant` for direct invocation.
+
+2. Grant permission for the server to run (for the session, workspace, or always).
+3. For best results, start a new chat for each new topic to maintain clean context.
+
+### Mode availability
+
+Syncfusion<sup style="font-size:70%">&reg;</sup> MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients.
+
+### Best Practices for Effective Usage
+
+1. `Be specific`: Mention both platform and control (e.g., "How do I create a Syncfusion JavaScript Grid with paging and filtering?").
+2. `Provide context`: Include details about your use case for more targeted solutions.
+3. `Use descriptive queries`: Avoid vague questions that lack necessary context.
+4. `Start fresh for new topics`: Begin a new chat session when switching controls or topics.
+
+### Example Queries
+
+Here are some effective ways to use SyncfusionJavaScriptAssistant:
+
+ * "Create a Syncfusion JavaScript Grid control with paging, sorting and filtering."
+ * "How do I implement data binding with Syncfusion JavaScript scheduler?"
+ * "Show me how to create a dashboard with multiple Syncfusion controls."
+
+## Troubleshooting
+
+If you encounter issues:
+
+ * Verify your API key is correctly configured.
+ * Ensure the MCP server is enabled in your client's tools selection.
+ * Check that you're using a compatible MCP client version.
+ * Try restarting your development environment.
+
+## Support
+
+Product support is available through the following mediums.
+
+* [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
+* [Community forum](https://www.syncfusion.com/forums/essential-js2)
+* [Request feature or report bug](https://www.syncfusion.com/feedback/javascript)
+* Live chat
+
+## License
+ This is a commercial product and requires a paid license for possession or use. Syncfusion<sup>®</sup> licensed software, including this control, is subject to the terms and conditions of [Syncfusion's EULA](https://www.syncfusion.com/eula/es/). To acquire a license, you can purchase [here](https://www.syncfusion.com/sales/products) or start a free 30-day trial [here](https://www.syncfusion.com/account/manage-trials/start-trials).
+ A free [community license](https://www.syncfusion.com/products/communitylicense) is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.
+     © Copyright 2025 Syncfusion<sup>®</sup> Inc. All Rights Reserved. The Syncfusion<sup>®</sup> Essential Studio<sup>®</sup> license and copyright applies to this distribution.
+    The Syncfusion<sup>®</sup> Essential<sup>®</sup> Studio license and copyright applies to this distribution.

package/dist/index.js

@@ -8,7 +8,7 @@ toolRegistry.register(SyncfusionJavaScriptAssistantTool);
 async function runServer() {
     const server = new McpServer({
         name: "SyncfusionJavaScriptAssistant",
-        version: "0.1.0"
+        version: "1.0.0"
     });
     for (const tool of toolRegistry.getAll()) {
         server.tool(tool.name, tool.description, tool.inputSchema, tool.handler);

package/dist/tools/javascript.js

@@ -1,21 +1,21 @@
 import { z } from "zod";
 import { callSyncfusionHelpbotAPI } from "../utils/helpbot.js";
 const TOOL_NAME = "SyncfusionJavaScriptAssistant";
-const TOOL_DESCRIPTION = `
-The ${TOOL_NAME} helps you with Syncfusion UI for JavaScript development questions and provides documentation references. This tool is useful when you need assistance with:
-
-1. Understanding specific Syncfusion JavaScript controls like Grid, Chart, Scheduler, DatePicker, etc.
-2. Implementation techniques for Syncfusion JavaScript controls.
-
-Provide your detailed question in the 'query' parameter. When your question involves specific Syncfusion JavaScript controls it will detect control references for retrieving relevant documentation and assistance.
-This tool understands the context based on the context MCP client will send the proper query to this server.
-This tool can be automatically triggered when any of the following phrases are detected in the user's input:
-- 'SyncfusionJavaScriptAssistant'
-- '/syncfusion-javascript-assistant'
-- '/syncfusion-javascript'
-- '@syncfusion-javascript'
-- '@ask_syncfusion_javascript'
-- 'ej2-javascript'
+const TOOL_DESCRIPTION = `
+The ${TOOL_NAME} helps you with Syncfusion UI for JavaScript development questions and provides documentation references. This tool is useful when you need assistance with:
+
+1. Understanding specific Syncfusion JavaScript controls like Grid, Chart, Scheduler, DatePicker, etc.
+2. Implementation techniques for Syncfusion JavaScript controls.
+
+Provide your detailed question in the 'query' parameter. When your question involves specific Syncfusion JavaScript controls it will detect control references for retrieving relevant documentation and assistance.
+This tool understands the context based on the context MCP client will send the proper query to this server.
+This tool can be automatically triggered when any of the following phrases are detected in the user's input:
+- 'SyncfusionJavaScriptAssistant'
+- '/syncfusion-javascript-assistant'
+- '/syncfusion-javascript'
+- '@syncfusion-javascript'
+- '@ask_syncfusion_javascript'
+- 'ej2-javascript'
 `;
 // Define the input schema shape for the tool
 const inputSchema = {

package/dist/utils/helpbot.js

@@ -1,5 +1,12 @@
 import axios from 'axios';
-const apiKey = process.env.Syncfusion_API_Key || "";
+import { readFileSync } from 'node:fs';
+let apiKey;
+if (process.env.Syncfusion_API_Key_Path) {
+    apiKey = readFileSync(process.env.Syncfusion_API_Key_Path, 'utf8');
+}
+else {
+    apiKey = process.env.Syncfusion_API_Key || "";
+}
 export async function callSyncfusionHelpbotAPI(query, platform, controls) {
     try {
         const resp = await axios.post("https://helpbot.syncfusion.com/api/documents/search", { "query": `${query} ${controls}`, "platform": platform, "tool": "javascript-mcp" }, {

package/license

@@ -0,0 +1,2 @@
+SyncfusionJavaScriptAssistant, part of the Essential JS 2 library, is available under the Syncfusion Essential Studio program and can be licensed under either the Syncfusion Community License Program or a Syncfusion commercial license. To be qualified for the Syncfusion Community License Program you must have a gross revenue of less than one (1) million U.S. dollars ($1,000,000.00 USD) per year and have less than five (5) developers in your organization, and agree to be bound by Syncfusion’s terms and conditions. Customers who do not qualify for the community license can contact sales@syncfusion.com for commercial licensing options. Under no circumstances can you use this product without (1) either a Community License or a commercial license and (2) without agreeing and abiding by Syncfusion’s license containing all terms and conditions. The Syncfusion license that contains the terms and conditions can be found at https://www.syncfusion.com/content/downloads/syncfusion_license.pdf
+ 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@syncfusion/javascript-assistant",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "MCP server that provides efficient access to Syncfusion documentation, implementation guidelines, and code generation for JavaScript",
   "type": "module",
+  "license": "SEE LICENSE IN license",
   "bin": {
     "javascript-assistant": "./dist/index.js"
   },
@@ -20,12 +21,7 @@
     "assets"
   ],
   "dependencies": {
-    "@modelcontextprotocol/sdk": "1.13.2",
-    "axios": "1.12.1"
-  },
-  "scripts": {
-    "build": "tsc",
-    "start": "tsc",
-    "inspector": "npx @modelcontextprotocol/inspector dist/index.js"
+    "@modelcontextprotocol/sdk": "1.23.0",
+    "axios": "1.13.2"
   }
 }