@syncfusion/maui-assistant 0.1.0 → 1.0.0

package/README.md

@@ -45,13 +45,33 @@ Before you can invoke the `SyncfusionMAUIAssistant` MCP server, you need to conf
 - **Arguments**: -y
 - **Server name**: syncfusionMAUIAssistant
 
-You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
+#### API Key Configuration
 
-```json
-"env": {
-  "Syncfusion_API_Key": "YOUR_API_KEY"
-}
-```
+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:
 
@@ -78,6 +98,8 @@ Below are setup instructions for popular MCP clients:
         "@syncfusion/maui-assistant@latest"
       ],
       "env": {
+        "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
         "Syncfusion_API_Key": "YOUR_API_KEY"
       }
     }
@@ -106,6 +128,8 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
         "@syncfusion/maui-assistant@latest"
       ],
       "env": {
+       "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
        "Syncfusion_API_Key": "YOUR_API_KEY"
       }
     }
@@ -129,6 +153,8 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
         "@syncfusion/maui-assistant@latest"
       ],
       "env": {
+       "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
        "Syncfusion_API_Key": "YOUR_API_KEY"
       }
     }

package/dist/index.js

@@ -8,7 +8,7 @@ toolRegistry.register(SyncfusionMAUIAssistantTool);
 async function runServer() {
     const server = new McpServer({
         name: "SyncfusionMAUIAssistant",
-        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/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, components) {
     try {
         const resp = await axios.post("https://helpbot.syncfusion.com/api/documents/search", { "query": `${query} ${components}`, "platform": platform, "tool": "maui-mcp" }, {

package/license

@@ -0,0 +1,7 @@
+This software is covered by the Software License Agreement (the “Agreement”)( https://www.syncfusion.com/content/downloads/syncfusion_license.pdf). Any use in any form, regardless of where it was obtained is governed by the Agreement. The Agreement is a legal agreement between you (“You”, “Your”, or “Customer”) and Syncfusion, Inc., a Delaware corporation with its principal place of business located at 2501 Aerial Center Parkway, Suite 200, Morrisville, NC 27560 (“Syncfusion”). By accessing, downloading, viewing, possessing, or otherwise using any part of Syncfusion’s Essential Studio product, you are agreeing to be bound by the terms and conditions and agree to register with Syncfusion. If you do not agree to be bound by the terms and conditions of the Agreement, you cannot access, register, use, or view any part of Syncfusion’s Essential Studio product or lines of code.
+ 
+This license is for Essential Studio Enterprise Edition.
+ 
+TO READ THE COMPLETE LICENSE AGREEMENT: https://www.syncfusion.com/content/downloads/syncfusion_license.pdf
+ 
+IF AFTER READING THIS AGREEMENT YOU HAVE ANY QUESTIONS ABOUT THIS AGREEMENT, PLEASE CONTACT SYNCFUSION PRIOR TO USING THE SOFTWARE PRODUCT VIA EMAIL AT LEGALQUESTIONS@SYNCFUSION.COM

package/package.json

@@ -1,31 +1,27 @@
-{
-  "name": "@syncfusion/maui-assistant",
-  "version": "0.1.0",
-  "description": "MCP server that provides efficient access to Syncfusion documentation, implementation guidelines, and code generation for MAUI",
-  "type": "module",
-  "bin": {
-    "maui-assistant": "./dist/index.js"
-  },
-  "keywords": [
-    "MCP Server",
-    "Model Context Protocol",
-    "MAUI",
-    "Syncfusion",
-    "AI",
-    "Copilot",
-    "SyncfusionMAUI"
-  ],
-  "files": [
-    "dist",
-    "assets"
-  ],
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "1.13.2",
-    "axios": "1.12.1"
-  },
-  "scripts": {
-    "build": "tsc",
-    "start": "tsc",
-    "inspector": "npx @modelcontextprotocol/inspector dist/index.js"
-  }
-}
+{
+  "name": "@syncfusion/maui-assistant",
+  "version": "1.0.0",
+  "description": "MCP server that provides efficient access to Syncfusion documentation, implementation guidelines, and code generation for MAUI",
+  "type": "module",
+  "license": "SEE LICENSE IN license",
+  "bin": {
+    "maui-assistant": "./dist/index.js"
+  },
+  "keywords": [
+    "MCP Server",
+    "Model Context Protocol",
+    "MAUI",
+    "Syncfusion",
+    "AI",
+    "Copilot",
+    "SyncfusionMAUI"
+  ],
+  "files": [
+    "dist",
+    "assets"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.23.0",
+    "axios": "1.13.2"
+  }
+}