1025844: Update UG and FT page for DOCX Editor SDK AI coding assistant

Document-Processing-toc.html

@@ -79,6 +79,9 @@
 							<li>
 								<a href="/document-processing/mcp-server/ai-coding-assistant/getting-started/pdfviewersdk">PDF Viewer SDK</a>
 							</li>
+							<li>
+								<a href="/document-processing/mcp-server/ai-coding-assistant/getting-started/docxeditorsdk">Docx Editor SDK</a>
+							</li>
 						</ul>
 					</li>
 					<li>

Document-Processing/mcp-server/ai-coding-assistant/getting-started/docxeditorsdk.md

@@ -0,0 +1,244 @@
+---
+layout: post
+title: SyncfusionDocxEditorSDKAssistant MCP Server Setup – Syncfusion
+description: Explore the MCP server’s benefits, setup needs, and integration guidance for Syncfusion DocxEdiorSDK.
+platform: document-processing
+control: AI coding assistant
+documentation: ug
+---
+
+# SyncfusionDocxEditorSDKAssistant MCP Server
+
+
+## Overview  
+
+The <a href ="https://www.npmjs.com/package/@syncfusion/docxeditorsdk-assistant">SyncfusionDocxEditorSDKAssistant</a> is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides intelligent, context-aware coding assistance for Syncfusion **DocxEditorSDK** across all supported platforms are JavaScript, Angular, React, Vue, ASP.NET MVC, ASP.NET Core, UWP, WPF and Blazor.
+It integrates seamlessly with [MCP clients](https://modelcontextprotocol.io/clients) to provide intelligent assistance for building applications with Syncfusion<sup style="font-size:70%">&reg;</sup> components.
+
+### Key Benefits
+
+  * Intelligent code generation for Syncfusion<sup>&reg;</sup> DocumentSDK components.
+  *	Detailed component documentation and usage examples.
+  *	Troubleshooting assistance for common integration challenges.
+
+## Prerequisites
+
+Before using <a href="https://www.npmjs.com/package/@syncfusion/docxeditorsdk-assistant">SyncfusionDocxEditorSDKAssistant</a>, 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>&reg;</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.)
+  *	An active Syncfusion<sup>&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>&reg;</sup> offers unlimited access to this MCP server. There are no restrictions on:
+
+  * Number of requests
+  *	Components usage
+  *	Query types
+  *	Usage duration
+
+This ensures users can fully leverage Syncfusion<sup>&reg;</sup> components to enhance their development experience without limitations.
+
+## Installation and setup
+
+Before you can invoke the ```SyncfusionDocxEditorSDKAssistant``` 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/docxeditorsdk-assistant```
+  *	**Type**: stdio (standard input/output transport)
+  *	**Command**: npx
+  *	**Arguments**: -y
+  *	**Server name**: syncfusionDocxEditorSDKAssistant
+
+#### 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"
+  }
+~~~
+
+<a href="https://www.npmjs.com/package/@syncfusion/docxeditorsdk-assistant">SyncfusionDocxEditorSDKAssistant</a> can be configured in various MCP clients. Below are setup instructions for popular environments:
+
+### Syncfusion<sup>&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 ```docxeditorsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/docxeditorsdk-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).
+
+For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers).
+
+### 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-docxeditorsdk-assistant": {   
+    "type": "stdio",
+    "command": "npx",
+    "args": [
+     "-y",
+     "@syncfusion/docxeditorsdk-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 <a href ="https://www.npmjs.com/package/@syncfusion/docxeditorsdk-assistant">SyncfusionDocxEditorSDKAssistant</a> server directly from the settings interface without additional commands.
+
+  * Confirm that <a href ="https://www.npmjs.com/package/@syncfusion/docxeditorsdk-assistant">SyncfusionDocxEditorSDKAssistant</a> is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
+
+      * ```SyncfusionDocxEditorSDKAssistant is running...``` (in VS Code)
+  * 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.
+
+~~~json 
+  {
+   "mcpServers": {
+    "syncfusion-docxeditorsdk-assistant": {
+     "type": "stdio",
+     "command": "npx",
+     "args": [
+     "-y",
+        "@syncfusion/docxeditorsdk-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
+
+  * 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-docxeditorsdk-assistant": {
+     "command": "npx",
+     "args": [
+      "-y",
+      "@syncfusion/docxeditorsdk-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 <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
+
+To activate the SyncfusionDocxEditorSDKAssistant MCP server:
+
+  1. Start your prompt with one of the following:
+      * SyncfusionDocxEditorSDKAssistant
+      * ‘/syncfusion-docxeditor-assistant’
+      *	‘/syncfusion-docxeditorsdk’
+      *	‘@syncfusion-docxeditorsdk’
+      *	‘@ask_syncfusion_docxeditorsdk’
+
+     In VS Code, you can also use #SyncfusionDocxEditorSDKAssistant to explicitly invoke the MCP server.
+
+  2. Grant the SyncfusionDocxEditorSDKAssistant 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® 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 component (e.g., "How do I apply character formatting to text in a React Syncfusion DocxEditor?").
+  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 components or topics
+
+### Example Queries
+
+Here are some effective ways to use <a href ="https://www.npmjs.com/package/@syncfusion/docxeditorsdk-assistant">SyncfusionDocxEditorSDKAssistant</a>:
+
+ * "Create a DOCX Editor and enable track changes"
+ * "How to protect documents with comments only restriction in ASP.NET Core DOCX editor?"
+ * "How to enable spell checking in DOCX editor?"
+ * "How to search for text and replace it in React DOCX editor?"
+
+## 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/docx-editor-sdk)
+  *	[Request feature or report bug](https://www.syncfusion.com/feedback/docx-editor-sdk)
+  *	Live chat
+
+## See also
+
+  * [Syncfusion  DocxEditorSDK Documentation](https://help.syncfusion.com/document-processing/word/word-processor/overview)
+
+
+
+

Document-Processing/mcp-server/ai-coding-assistant/overview.md

@@ -20,6 +20,8 @@ AI Coding Assistant:
 
   * **The SyncfusionPDFViewerSDKAssistant MCP Server** is engineered to interpret advanced natural‑language prompts and deliver intelligent, context‑aware code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients). Its primary goal is to simplify and accelerate development by bringing a rich suite of **[PDF Viewer features](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview)** directly into application workflows. It is compatible with a wide range of platforms, such as Windows Forms, WPF, JavaScript, Angular, React, Vue, ASP.NET MVC, ASP.NET Core, Blazor, MAUI, and Flutter.
 
+  * **The SyncfusionDocxEditorSDKAssistant MCP Server** is designed to process advanced prompts and deliver intelligent, context-aware code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients). It specifically enhances developer productivity with **[Docx Editor](https://help.syncfusion.com/document-processing/word/word-processor/overview)** capabilities across multiple platforms, including ASP.NET Core, ASP.NET MVC, Angular, React, Vue, JavaScript (ES5/ES6), UWP, WPF, and Blazor.
+
 ## Getting Started
 
 To use the AI Coding Assistant, you need:
@@ -42,6 +44,8 @@ To use the AI Coding Assistant, you need:
   * Add the <a href="./getting-started/documentsdk">SyncfusionDocumentSDKAssistant MCP Server</a>  to an MCP-enabled client
   * Add the <a href="./getting-started/spreadsheeteditorsdk">SyncfusionSpreadsheetEditorSDKAssistant MCP Server</a>  to an MCP-enabled client
   * Add the <a href="./getting-started/pdfviewersdk">The SyncfusionPDFViewerSDKAssistant MCP Server</a>  to an MCP-enabled client
+  * Add the <a href="./getting-started/docxeditorsdk">The SyncfusionDocxEditorSDKAssistant MCP Server</a>  to an MCP-enabled client
   *	[Syncfusion<sup>&reg;</sup> Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction)
   *	[Syncfusion<sup>&reg;</sup> SpreadsheetEditor SDK Documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/overview)
-  *	[Syncfusion<sup>&reg;</sup> PDFViewer SDK Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview)  
+  *	[Syncfusion<sup>&reg;</sup> PDFViewer SDK Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview)
+  *	[Syncfusion<sup>&reg;</sup> DocxEditor SDK Documentation](https://help.syncfusion.com/document-processing/word/word-processor/overview)

Document-Processing/mcp-server/overview.md

@@ -33,6 +33,7 @@ Syncfusion MCP Servers are delivered as .NET-based Model Context Protocol (MCP)
 * SyncfusionDocumentSDKAssistant
 * SyncfusionSpreadsheetEditorSDKAssistant
 * SyncfusionPDFViewerSDKAssistant
+* SyncfusionDocxEditorSDKAssistant
 
 ## Unlimited Access