diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index 597f4b0e44..a750ef4e11 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -73,6 +73,9 @@
  • Document SDK
    • +
  • + DOCX Editor SDK +
  • Spreadsheet Editor SDK
    • diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/docxeditorsdk.md b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/docxeditorsdk.md new file mode 100644 index 0000000000..9eff9902cb --- /dev/null +++ b/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 SyncfusionDOCXEditorSDKAssistant 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 Angular, React, Vue, JavaScript, ASP.NET MVC, ASP.NET Core, Blazor, UWP and WPF. +It integrates seamlessly with [MCP clients](https://modelcontextprotocol.io/clients) to provide intelligent assistance for building applications with Syncfusion® components. + +### Key Benefits + + * Intelligent code generation for Syncfusion® DOCXEditorSDK components. + * Detailed component documentation and usage examples. + * Troubleshooting assistance for common integration challenges. + +## Prerequisites + +Before using SyncfusionDOCXEditorSDKAssistant, 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® CodeStudio](https://www.syncfusion.com/code-studio/), etc.) + * An active Syncfusion® 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® 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® 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" + } +~~~ + +SyncfusionDOCXEditorSDKAssistant can be configured in various MCP clients. Below are setup instructions for popular environments: + +### Syncfusion® 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 SyncfusionDOCXEditorSDKAssistant server directly from the settings interface without additional commands. + + * Confirm that SyncfusionDOCXEditorSDKAssistant 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 Visual Studio documentation. + +### 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 Cursor documentation. + +### 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 JetBrains documentation. + +> 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 can I apply font size character formatting to text in a React Syncfusion DOCX Editor?"). + 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 SyncfusionDOCXEditorSDKAssistant: + + * "How to search for text and replace it in React DOCX Editor?" + * "Show me code to insert bookmarks in Angular DOCX Editor?" + * "How to protect documents with comments only restriction in ASP.NET Core DOCX Editor?" + * "Provide an example of adding custom context menu items in a Blazor 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) + + + + diff --git a/Document-Processing/mcp-server/ai-coding-assistant/overview.md b/Document-Processing/mcp-server/ai-coding-assistant/overview.md index 1eea3e13a8..6c2318ac1d 100644 --- a/Document-Processing/mcp-server/ai-coding-assistant/overview.md +++ b/Document-Processing/mcp-server/ai-coding-assistant/overview.md @@ -16,6 +16,8 @@ AI Coding Assistant: * **The SyncfusionDocumentSDKAssistant MCP Server** is designed to process advanced prompts and return intelligent, context-aware code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients). It specifically enhances productivity when working with **Syncfusion® Document Processing libraries**, including **[PDF](https://help.syncfusion.com/document-processing/pdf/overview)**, **[Word](https://help.syncfusion.com/document-processing/word/overview) (DocIO)**, **[Excel](https://help.syncfusion.com/document-processing/excel/overview) (XlsIO)**, and **[PowerPoint](https://help.syncfusion.com/document-processing/powerpoint/overview) (Presentation)**. + * **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, Blazor, Angular, React, Vue, JavaScript (ES5/ES6), UWP and WPF. + * **The SyncfusionSpreadsheetEditorSDKAssistant MCP Server** is designed to process advanced prompts and return intelligent, context-aware code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients). It specifically enhances developer productivity with **[Spreadsheet](https://help.syncfusion.com/document-processing/excel/spreadsheet/overview)** capabilities across multiple platforms, including ASP.NET Core, ASP.NET MVC, Angular, React, Vue, JavaScript (ES5/ES6), UWP, Windows Forms, WPF, and Blazor. * **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. @@ -40,8 +42,10 @@ To use the AI Coding Assistant, you need: ## See also * Add the SyncfusionDocumentSDKAssistant MCP Server to an MCP-enabled client + * Add the The SyncfusionDOCXEditorSDKAssistant MCP Server to an MCP-enabled client * Add the SyncfusionSpreadsheetEditorSDKAssistant MCP Server to an MCP-enabled client * Add the The SyncfusionPDFViewerSDKAssistant MCP Server to an MCP-enabled client * [Syncfusion® Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) + * [Syncfusion® DOCXEditor SDK Documentation](https://help.syncfusion.com/document-processing/word/word-processor/overview) * [Syncfusion® SpreadsheetEditor SDK Documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/overview) - * [Syncfusion® PDFViewer SDK Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview) \ No newline at end of file + * [Syncfusion® PDFViewer SDK Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview) diff --git a/Document-Processing/mcp-server/overview.md b/Document-Processing/mcp-server/overview.md index 6743fd0e94..1fb0ac5419 100644 --- a/Document-Processing/mcp-server/overview.md +++ b/Document-Processing/mcp-server/overview.md @@ -31,6 +31,7 @@ Syncfusion MCP Servers are delivered as .NET-based Model Context Protocol (MCP) **Available MCP Servers** * SyncfusionDocumentSDKAssistant +* SyncfusionDOCXEditorSDKAssistant * SyncfusionSpreadsheetEditorSDKAssistant * SyncfusionPDFViewerSDKAssistant