@syncfusion/documentsdk-assistant 0.1.0 → 1.0.0

package/README.md

@@ -45,22 +45,43 @@ Before you can invoke the `SyncfusionDocumentSDKAssistant` MCP server, you need
 - **Arguments**: -y
 - **Server name**: syncfusionDocumentSDKAssistant
 
-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"
+  }
+  ```
 
 SyncfusionDocumentSDKAssistant 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 `SyncfusionDocumentSDKAssistant`, 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).
+  *	In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the ```Custom Servers``` tab.
+  *	Enter the Server Name as ```documentsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/documentsdk-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).
 
 ### VS Code (GitHub Copilot MCP)
 
@@ -77,6 +98,8 @@ SyncfusionDocumentSDKAssistant can be configured in various MCP clients. Below a
         "@syncfusion/documentsdk-assistant@latest"
       ],
       "env": {
+        "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
         "Syncfusion_API_Key": "YOUR_API_KEY"
       }
     }
@@ -84,11 +107,13 @@ SyncfusionDocumentSDKAssistant can be configured in various MCP clients. Below a
 }
 ```
 
-2. After updating the configuration in settings.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the SyncfusionDocumentSDKAssistant server directly from the settings interface without additional commands.
+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 SyncfusionDocumentSDKAssistant server directly from the settings interface without additional commands.
 
 3. Confirm that SyncfusionDocumentSDKAssistant is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
     * `SyncfusionDocumentSDKAssistant is running...` (in VS Code)
 
+4. For more details, refer to the official <a href = "https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022"> Visual Studio documentation</a>.
+
 ### Cursor
 
 To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder.
@@ -104,12 +129,15 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
         "@syncfusion/documentsdk-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 <a href = "https://docs.cursor.com/en/context/mcp#using-mcp-json">Cursor documentation</a>.
 
 ### JetBrains IDEs
 
@@ -127,6 +155,8 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
         "@syncfusion/documentsdk-assistant@latest"
       ],
       "env": {
+       "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
+        // or
        "Syncfusion_API_Key": "YOUR_API_KEY"
       }
     }
@@ -136,11 +166,10 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
 
 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)
+For further assistance, see the <a href ="https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server">JetBrains documentation</a>.
+
+> 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
 

package/dist/index.js

@@ -8,7 +8,7 @@ toolRegistry.register(SyncfusionDocumentSDKAssistantTool);
 async function runServer() {
     const server = new McpServer({
         name: "SyncfusionDocumentSDKAssistant",
-        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": "documentsdk-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/documentsdk-assistant",
-  "version": "0.1.0",
-  "description": "MCP server that provides efficient access to Syncfusion documentation, implementation guidelines, and code generation for document processing libraries.",
-  "type": "module",
-  "bin": {
-    "documentsdk-assistant": "./dist/index.js"
-  },
-  "keywords": [
-    "MCP Server",
-    "Model Context Protocol",
-    "Document Processing Libraries",
-    "Syncfusion",
-    "AI",
-    "Copilot",
-    "SyncfusionDocumentSDK"
-  ],
-  "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/documentsdk-assistant",
+  "version": "1.0.0",
+  "description": "MCP server that provides efficient access to Syncfusion documentation, implementation guidelines, and code generation for document processing libraries.",
+  "type": "module",
+  "license": "SEE LICENSE IN license",
+  "bin": {
+    "documentsdk-assistant": "./dist/index.js"
+  },
+  "keywords": [
+    "MCP Server",
+    "Model Context Protocol",
+    "Document Processing Libraries",
+    "Syncfusion",
+    "AI",
+    "Copilot",
+    "SyncfusionDocumentSDK"
+  ],
+  "files": [
+    "dist",
+    "assets"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.23.0",
+    "axios": "1.13.2"
+  }
+}