diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index 45ef091008..3b1cb528be 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -153,7 +153,40 @@
  • - MCP Server + MCP Server +
    • diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/documentsdk.md b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/documentsdk.md new file mode 100644 index 0000000000..c30b7b3cd1 --- /dev/null +++ b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/documentsdk.md @@ -0,0 +1,240 @@ +--- +layout: post +title: SyncfusionDocumentSDKAssistant MCP Server Setup – Syncfusion +description: Explore the MCP server’s benefits, setup needs, and integration guidance for Syncfusion DocumentSDK. +platform: document-processing +control: AI coding assistant +documentation: ug +--- + +# SyncfusionDocumentSDKAssistant MCP Server + + +## Overview + +The SyncfusionDocumentSDKAssistant is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion’s DocumentSDK libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building .NET applications with Syncfusion® Document Processing libraries, such as PDF, Word, Excel, and PowerPoint. + +### Key Benefits + + * Intelligent code generation for Syncfusion® DocumentSDK components. + * Detailed component documentation and usage examples. + * Troubleshooting assistance for common integration challenges. + +## Prerequisites + +Before using SyncfusionDocumentSDKAssistant, 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. + +## 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" + } +~~~ + +SyncfusionDocumentSDKAssistant can be configured in various MCP clients. Below are setup instructions for popular environments: + +## Setting up in MCP Clients + +Create a configuration file in your project folder to install the server for your workspace as shown below: + +**Important:** Replace `YOUR_API_KEY_FILE_PATH` with the path to your API key file. + +{% tabs %} + +{% highlight json tabtitle="VS Code" %} +// Create a `.vscode/mcp.json` file in your workspace with the MCP server configuration: + +{ + "servers": { + "syncfusion-documentsdk-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/documentsdk-assistant@latest" + ], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", + // or + "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } + } +{% endhighlight %} + +{% highlight json tabtitle="Syncfusion Code Studio" %} +// Create a `.codestudio/mcp.json` file in your workspace with the MCP server configuration: + +{ + "servers": { + "syncfusion-documentsdk-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/documentsdk-assistant@latest" + ], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", + // or + "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } + } +{% endhighlight %} + +{% highlight json tabtitle="Cursor" %} +// Create a `.cursor/mcp.json` file in your workspace with the MCP server configuration: + +{ + "mcpServers": { + "syncfusion-documentsdk-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/documentsdk-assistant@latest" + ], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", + // or + "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } + } +{% endhighlight %} + +{% highlight json tabtitle="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: + +{ + "mcpServers": { + "syncfusion-documentsdk-assistant": { + "command": "npx", + "args": [ + "-y", + "@syncfusion/documentsdk-assistant@latest" + ], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", + // or + "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } + } +{% endhighlight %} + +{% endtabs %} + +**Verify Installation:** Check your editor's MCP Server list for `syncfusion-documentsdk-assistant` with "Connected" status to confirm successful installation. + +## Usage + +To activate the SyncfusionDocumentSDKAssistant MCP server: + + 1. Start your prompt with one of the following: + * ‘SyncfusionDocumentSDKAssistant’ + * ‘/syncfusion-document-assistant’ + * ‘/syncfusion-documentsdk’ + * ‘@syncfusion-documentsdk’ + * ‘@ask_syncfusion_documentsdk’ + + In VS Code, you can also use #SyncfusionDocumentSDKAssistant to explicitly invoke the MCP server. + + 2. Grant the SyncfusionDocumentSDKAssistant 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 to digitally sign a PDF document using Syncfusion PDF library in .NET Core app?"). + 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 SyncfusionDocumentSDKAssistant: + + * "Create an Excel file with formulas, charts, and conditional formatting using Syncfusion in WPF." + * "How to perform a mail merge in a Word document using Syncfusion Word library?" + * "Extract text and images from an existing PDF using Syncfusion." + * "How do I convert a Word document to PDF using Syncfusion in Blazor app?" + * "Using Syncfusion, how can I combine multiple PowerPoint presentations into one in a WinUI application?" + +## Troubleshooting + +If you encounter issues during installation or while using the MCP server, refer to the solutions below: + +| Issue | Solution | +|-------|----------| +| Clear npm cache | Run `npx clear-npx-cache` and restart your IDE to resolve package caching issues | +| Server failed to start | Update to Node.js 18+, verify JSON syntax in config file, and restart your IDE | +| Invalid API key | Verify your key is active at [Syncfusion Account Page](https://syncfusion.com/account/api-key) | +| Incorrect API key config | For the file path: Verify file location and content. For inline key: Check key is properly updated | +| Wrong config file location | VS Code: `.vscode/mcp.json`
    Code Studio: `.codestudio/mcp.json`
    Cursor: `.cursor/mcp.json`
    JetBrains: Settings → Tools → AI Assistant → MCP in the workspace root | +| Check IDE logs | VS Code/Code Studio: Output panel → "MCP" • Cursor: Developer Console for MCP errors • JetBrains: IDE logs | + +## Support + +Product support is available through the following mediums. + + * [Support ticket](https://support.syncfusion.com/support/tickets/create) + * [Community forum](https://www.syncfusion.com/forums/document-sdk) + * [Request feature or report bug](https://www.syncfusion.com/feedback/document-sdk) + +## See also + + * [Syncfusion DocumentSDK Documentation](https://help.syncfusion.com/document-processing/introduction) + + + + 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/getting-started/images/pdfviewer/code-studio-marketplace.png b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/code-studio-marketplace.png new file mode 100644 index 0000000000..bd52861202 Binary files /dev/null and b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/code-studio-marketplace.png differ diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-custom-server.png b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-custom-server.png new file mode 100644 index 0000000000..4f7c71ab9d Binary files /dev/null and b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-custom-server.png differ diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-npm-package.png b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-npm-package.png new file mode 100644 index 0000000000..2997f721d0 Binary files /dev/null and b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-npm-package.png differ diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-runtime-window.png b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-runtime-window.png new file mode 100644 index 0000000000..9099a577e6 Binary files /dev/null and b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-runtime-window.png differ diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-server-installed.png b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-server-installed.png new file mode 100644 index 0000000000..707d13f436 Binary files /dev/null and b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-server-installed.png differ diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-start-pdfviewer.png b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-start-pdfviewer.png new file mode 100644 index 0000000000..ce6e8d5a2c Binary files /dev/null and b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-start-pdfviewer.png differ diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-syncfusion-api-key.png b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-syncfusion-api-key.png new file mode 100644 index 0000000000..3e1928b7b3 Binary files /dev/null and b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/images/pdfviewer/mcp-syncfusion-api-key.png differ diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/pdfviewersdk.md b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/pdfviewersdk.md new file mode 100644 index 0000000000..3b58f7f77f --- /dev/null +++ b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/pdfviewersdk.md @@ -0,0 +1,250 @@ +--- +layout: post +title: SyncfusionPDFViewerSDKAssistant MCP Server Setup – Syncfusion +description: Explore the MCP server’s benefits, setup needs, and integration guidance for Syncfusion PDFViewerSDK. +platform: document-processing +control: AI coding assistant +documentation: ug +--- + +# SyncfusionPDFViewerSDKAssistant MCP Server + +## Overview + +The SyncfusionPDFViewerSDKAssistant is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides intelligent, context-aware coding assistance for Syncfusion **PDFViewerSDK** across all supported platforms are Windows Forms, WPF, JavaScript, Angular, React, Vue, ASP.NET MVC, ASP.NET Core, Blazor, MAUI and Flutter. +It integrates seamlessly with [MCP clients](https://modelcontextprotocol.io/clients) to provide intelligent assistance for building applications with Syncfusion® components. + +### Key Benefits + +- Instant code generation & explanations for Syncfusion® PDFViewerSDK component. +- Detailed component documentation and usage examples. +- Troubleshooting assistance for common integration challenges. + +## Prerequisites + +Before using SyncfusionPDFViewerSDKAssistant, 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 ```SyncfusionPDFViewerSDKAssistant``` 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/pdfviewersdk-assistant``` +- **Type**: stdio (standard input/output transport) +- **Command**: npx +- **Arguments**: -y +- **Server name**: syncfusionPDFViewerSDKAssistant + +#### 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" + } +~~~ + +[SyncfusionPDFViewerSDKAssistant](https://www.npmjs.com/package/@syncfusion/pdfviewersdk-assistant) can be configured in various MCP clients. Below are setup instructions for popular environment: + +### Syncfusion® Code Studio + + * In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace + ![Code Studio Marketplace](images/pdfviewer/code-studio-marketplace.png) + * Go to the ```Custom Servers``` tab and click **Add MCP Servers** + ![Custom Server Tab](images/pdfviewer/mcp-custom-server.png) + * In the dialog that appears, select **Accept and Continue** to launch the runtime window for configuring the PDF Viewer SDK MCP. + ![Run Time Window](images/pdfviewer/mcp-runtime-window.png) + * Choose the NPM package installation mode. Enter the command **@syncfusion/pdfviewersdk-assistant** in the runtime window and press **Enter** + ![NPM package](images/pdfviewer/mcp-npm-package.png) + * When prompted, click allow in the opened options and select **Direct API key**. Enter the API key generated from the [Syncfusion API key](https://www.syncfusion.com/account/api-key), then press **Enter**. + ![Syncfusion API key](images/pdfviewer/mcp-syncfusion-api-key.png) + * Provide server name such as ```syncfusion-pdfviewersdk-assistant```, then press **Enter**. The PDF Viewer SDK MCP server will get installed. + * Once installed, the server will appear in the User Installed Server list and will be added to the **config.yaml** file. + ![PDF Viewer MCP server](images/pdfviewer/mcp-server-installed.png) + * 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-pdfviewersdk-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/pdfviewersdk-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 SyncfusionPDFViewerSDKAssistant server directly from the settings interface without additional commands. +![Start PDF Viewer AI Assistant](images/pdfviewer/mcp-start-pdfviewer.png) +* Confirm that [SyncfusionPDFViewerSDKAssistant](https://www.npmjs.com/package/@syncfusion/pdfviewersdk-assistant) is being used (this does not happen automatically). Look for a statement in the output, which is similar to: + * ```SyncfusionPDFViewerSDKAssistant 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-pdfviewersdk-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/pdfviewersdk-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-pdfviewersdk-assistant": { + "command": "npx", + "args": [ + "-y", + "@syncfusion/pdfviewersdk-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 SyncfusionPDFViewerSDKAssistant MCP server: + +1. Start your prompt with one of the following: + * 'SyncfusionPDFViewerSDKAssistant' + * '/syncfusion-pdfviewersdk-assistant' + * '/syncfusion-pdfviewersdk' + * '@syncfusion-pdfviewersdk' + * '@ask_syncfusion_pdfviewersdk' + + In VS Code, you can also use #SyncfusionPDFViewerSDKAssistant to explicitly invoke the MCP server. + +2. Grant the SyncfusionPDFViewerSDKAssistant 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 conditional formatting to highlight duplicate values in a React Syncfusion Spreadsheet?"). +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 [SyncfusionPDFViewerSDKAssistant](https://www.npmjs.com/package/@syncfusion/pdfviewersdk-assistant): + + * "Provide code for viewing PDF files using the PDF Viewer in a Blazor Web App." + * "Show me a code snippet to load a PDF from Google Drive into Syncfusion PDF Viewer using React" + * "How do I toggle the annotation toolbar using Angular PDF Viewer" + * "Explain how to open the thumbnail panel programmatically in Syncfusion PDF Viewer using Vue." + * "Provide code to restrict zoom levels between 150% and 300% in JavaScript PDF Viewer." + +## 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/pdf-viewer-sdk) +* [Request feature or report bug](https://www.syncfusion.com/feedback/pdf-viewer-sdk) +* Live chat + +## See also + + * [Syncfusion PDFViewerSDK Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview) diff --git a/Document-Processing/mcp-server/ai-coding-assistant/getting-started/spreadsheeteditorsdk.md b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/spreadsheeteditorsdk.md new file mode 100644 index 0000000000..de2800345a --- /dev/null +++ b/Document-Processing/mcp-server/ai-coding-assistant/getting-started/spreadsheeteditorsdk.md @@ -0,0 +1,241 @@ +--- +layout: post +title: SyncfusionSpreadsheetEditorSDKAssistant MCP Server Setup – Syncfusion +description: Explore the MCP server’s benefits, setup needs, and integration guidance for Syncfusion SpreadsheetEditorSDK. +platform: document-processing +control: AI coding assistant +documentation: ug +--- + +# SyncfusionSpreadsheetEditorSDKAssistant MCP Server + +## Overview + +The SyncfusionSpreadsheetEditorSDKAssistant is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides intelligent, context-aware coding assistance for Syncfusion **EJ2 Spreadsheet** and **SpreadsheetEditorSDK** across all supported platforms are ASP.NET Core, ASP.NET MVC, Angular, React, Vue, JavaScript, (ES5), JavaScript (ES6), UWP, Windows Forms, WPF, Blazor. +It integrates seamlessly with [MCP clients](https://modelcontextprotocol.io/clients) to provide intelligent assistance for building applications with Syncfusion® components. + +### Key Benefits + +- Instant code generation & explanations for Syncfusion® SpreadsheetEditorSDK component. +- Detailed component documentation and usage examples. +- Troubleshooting assistance for common integration challenges. + +## Prerequisites + +Before using SyncfusionSpreadsheetEditorSDKAssistant, 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 ```SyncfusionSpreadsheetEditorSDKAssistant``` 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/spreadsheeteditorsdk-assistant``` +- **Type**: stdio (standard input/output transport) +- **Command**: npx +- **Arguments**: -y +- **Server name**: syncfusionSpreadsheetEditorSDKAssistant + +#### 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" + } +~~~ + +[SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) can be configured in various MCP clients. Below are setup instructions for popular environment: + +### 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 ```spreadsheeteditorsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/spreadsheeteditorsdk-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-spreadsheeteditorsdk-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/spreadsheeteditorsdk-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 SyncfusionSpreadsheetEditorSDKAssistant server directly from the settings interface without additional commands. + +* Confirm that [SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) is being used (this does not happen automatically). Look for a statement in the output, which is similar to: + * ```SyncfusionSpreadsheetEditorSDKAssistant 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-spreadsheeteditorsdk-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/spreadsheeteditorsdk-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-spreadsheeteditorsdk-assistant": { + "command": "npx", + "args": [ + "-y", + "@syncfusion/spreadsheeteditorsdk-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 SyncfusionSpreadsheetEditorSDKAssistant MCP server: + +1. Start your prompt with one of the following: + * 'SyncfusionSpreadsheetEditorSDKAssistant' + * '/syncfusion-spreadsheeteditorsdk-assistant' + * '/syncfusion-spreadsheeteditorsdk' + * '@syncfusion-spreadsheeteditorsdk' + * '@ask_syncfusion_spreadsheeteditorsdk' + + In VS Code, you can also use #SyncfusionSpreadsheetEditorSDKAssistant to explicitly invoke the MCP server. + +2. Grant the SyncfusionSpreadsheetEditorSDKAssistant 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 conditional formatting to highlight duplicate values in a React Syncfusion Spreadsheet?"). +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 [SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant): + + * "Provide TypeScript examples of using VLOOKUP and SUMIF formulas in Syncfusion Spreadsheet." + * "Show me how to perform data validation with dropdown lists in Vue Spreadsheet." + * "How do I merge cells and apply borders programmatically in ASP.NET Core Spreadsheet?" + * "Explain how to enable virtual scrolling in Syncfusion EJ2 Spreadsheet with large datasets." + * "How can I protect specific sheets and lock certain ranges in Syncfusion Spreadsheet for MVC?" + +## 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/spreadsheet-editor-sdk) +* [Request feature or report bug](https://www.syncfusion.com/feedback/spreadsheet-editor-sdk) +* Live chat + +## See also + + * [Syncfusion SpreadsheetEditorSDK Documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/overview) diff --git a/Document-Processing/mcp-server/ai-coding-assistant/overview.md b/Document-Processing/mcp-server/ai-coding-assistant/overview.md new file mode 100644 index 0000000000..6c2318ac1d --- /dev/null +++ b/Document-Processing/mcp-server/ai-coding-assistant/overview.md @@ -0,0 +1,51 @@ +--- +layout: post +title: Overview of AI Coding Assistant for DocumentSDK – Syncfusion +description: Get a quick overview of Syncfusion’s AI Coding Assistants that simplify document processing and deliver query results efficiently +platform: document-processing +control: AI coding assistant +documentation: ug +--- + +# Syncfusion® AI Coding Assistant Overview + + +The **Syncfusion® AI Coding Assistant** are designed to streamline your development workflow when building applications with Syncfusion® components. It uses contextual knowledge of the Syncfusion® components to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. + +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. + +## Getting Started + +To use the AI Coding Assistant, you need: + + * A [Syncfusion® user account](https://www.syncfusion.com/account) + * 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) + * Any project setup that includes Syncfusion Document Processing® components + +## Recommendations + + * Session Management: Start new sessions when switching tasks to ensure prompt relevance and maintain content focus. + * Model Compatibility: For optimal performance, use the tools with advanced AI models such as GPT-5 or Claude Sonnet 4. + +## 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) diff --git a/Document-Processing/mcp-server/ai-coding-assistant/prompt-library.md b/Document-Processing/mcp-server/ai-coding-assistant/prompt-library.md new file mode 100644 index 0000000000..c83b2ca3d4 --- /dev/null +++ b/Document-Processing/mcp-server/ai-coding-assistant/prompt-library.md @@ -0,0 +1,280 @@ +--- +layout: post +title: Syncfusion AI Coding Assistant Prompt Library | Syncfusion +description: Explore the AI Coding Assistant Prompt Library to enhance DocumentSDK productivity with code generation and configuration guidance. +platform: document-processing +control: Syncfusion AI Coding Assistant Prompt Library +documentation: ug +domainurl: ##DomainURL## +--- + +# Prompt Library - AI Coding Assistant + +Speed up your projects using these ready-made prompts for Syncfusion® components. Each prompt is short, easy to understand, and focused on real tasks—like quick setups, tweaks, and fixes. + +## How to Use + +Before starting, make sure your MCP Server is set up and running. + +* Choose a prompt that fits your need. +* Copy the full prompt with the appropriate assistant handle (for example, `#SyncfusionDocumentSDKAssistant` or `#SyncfusionSpreadsheetEditorSDKAssistant`). +* Customize the prompt for your specific use case. +* Execute via the MCP Server. +* Always check and test the code before adding it to your project. + +## Component-Specific Prompts + +### PDF + +The Syncfusion PDF Library enables developers to create, read, and edit PDF documents programmatically across all .NET applications. + +{% promptcards %} +{% promptcard Create PDF %} +#SyncfusionDocumentSDKAssistant Show me how to create text and images in a PDF document? +{% endpromptcard %} +{% promptcard Edit and Save %} +#SyncfusionDocumentSDKAssistant How can I open an existing PDF, modify its content, and save the updated file in ASP.NET MVC? +{% endpromptcard %} +{% promptcard Form Fields %} +#SyncfusionDocumentSDKAssistant How can I create form fields and add combo and radio box in PDF document? +{% endpromptcard %} +{% promptcard Bookmarks %} +#SyncfusionDocumentSDKAssistant How do I add, edit, and remove bookmarks in a PDF? +{% endpromptcard %} +{% promptcard Watermarks %} +#SyncfusionDocumentSDKAssistant Provide steps to add text watermarks and image watermarks to a PDF? +{% endpromptcard %} +{% promptcard Table and Shape %} +#SyncfusionDocumentSDKAssistant Insert an image on a new PDF page, add a table, draw a shape, and place text inside the shape? +{% endpromptcard %} +{% promptcard ZUGFeRD Invoices %} +#SyncfusionDocumentSDKAssistant Provide an example to generate a ZUGFeRD-compliant invoice PDF? +{% endpromptcard %} +{% promptcard Merge and Split %} +#SyncfusionDocumentSDKAssistant How do I merge multiple PDFs and split a PDF into separate files or pages? +{% endpromptcard %} +{% promptcard Compress PDF %} +#SyncfusionDocumentSDKAssistant How do I compress an existing PDF and optimize it for a smaller file size? +{% endpromptcard %} +{% promptcard Digital Signatures %} +#SyncfusionDocumentSDKAssistant Provide steps to digitally sign a PDF and validate existing signatures? +{% endpromptcard %} +{% promptcard XPS to PDF Conversion %} +#SyncfusionDocumentSDKAssistant How do I convert XPS documents to PDF? +{% endpromptcard %} +{% promptcard HTML to PDF Conversion %} +#SyncfusionDocumentSDKAssistant How do I convert HTML documents to PDF? +{% endpromptcard %} +{% promptcard Security Operations %} +#SyncfusionDocumentSDKAssistant Show me how to encrypt a PDF with password and later decrypt it? +{% endpromptcard %} +{% endpromptcards %} + +### Word + +The Syncfusion Word Library enables developers to create, read, edit, and convert Word documents programmatically across all .NET applications. + +{% promptcards %} +{% promptcard Create Word Document %} +#SyncfusionDocumentSDKAssistant Show me how to create a Word document from scratch with paragraphs in new document? +{% endpromptcard %} +{% promptcard Edit and Save %} +#SyncfusionDocumentSDKAssistant How can I open an existing DOCX, modify content and save the document? +{% endpromptcard %} +{% promptcard Mail Merge %} +#SyncfusionDocumentSDKAssistant How to create a Word template document with merge fields? +{% endpromptcard %} +{% promptcard Bookmarks %} +#SyncfusionDocumentSDKAssistant How to navigate to a bookmark and insert contents in DOCX? +{% endpromptcard %} +{% promptcard Split Documents %} +#SyncfusionDocumentSDKAssistant How do I split a Word document into multiple files by section? +{% endpromptcard %} +{% promptcard Table and Shapes %} +#SyncfusionDocumentSDKAssistant Insert a table in new page, draw a shape, and place text inside the shape in Word document? +{% endpromptcard %} +{% promptcard Table of Contents (TOC) %} +#SyncfusionDocumentSDKAssistant How can I insert TOC in Word Document? +{% endpromptcard %} +{% promptcard Forms %} +#SyncfusionDocumentSDKAssistant How do I create a checkbox and dropdown field in a Word document for ASP.NET Core? +{% endpromptcard %} +{% promptcard Fields %} +#SyncfusionDocumentSDKAssistant How to update the fields present in Word document? +{% endpromptcard %} +{% promptcard Styles and Formatting %} +#SyncfusionDocumentSDKAssistant How can I define and apply paragraph, styles, bullet lists in Word document? +{% endpromptcard %} +{% promptcard HTML to DOCX %} +#SyncfusionDocumentSDKAssistant Provide code to convert HTML to DOCX Document? +{% endpromptcard %} +{% promptcard Find and Replace %} +#SyncfusionDocumentSDKAssistant How to find text and replace with other text in Word document? +{% endpromptcard %} +{% promptcard Security %} +#SyncfusionDocumentSDKAssistant Show me how to encrypt the Word document with password? +{% endpromptcard %} +{% promptcard Compare %} +#SyncfusionDocumentSDKAssistant How to compare two Word documents? +{% endpromptcard %} +{% promptcard Math Equation %} +#SyncfusionDocumentSDKAssistant How to create accent equation using LaTeX in Word document? +{% endpromptcard %} +{% promptcard Word to PDF %} +#SyncfusionDocumentSDKAssistant How to convert a Word document into PDF document? +{% endpromptcard %} +{% promptcard Word to MD %} +#SyncfusionDocumentSDKAssistant How to convert a Word document to a Markdown? +{% endpromptcard %} +{% endpromptcards %} + +### Excel + +The Syncfusion Excel Library enables developers to create, read, edit, and convert Excel documents programmatically across all .NET applications. + +{% promptcards %} +{% promptcard Create Excel Document %} +#SyncfusionDocumentSDKAssistant How to create an Excel file from scratch? +{% endpromptcard %} +{% promptcard Edit and Save %} +#SyncfusionDocumentSDKAssistant How can I open an existing Excel document, modify content and save the document? +{% endpromptcard %} +{% promptcard Import Data from Data Table to Excel %} +#SyncfusionDocumentSDKAssistant How do I import a Data Table into a new Excel worksheet using Document SDK? +{% endpromptcard %} +{% promptcard Conditional Format %} +#SyncfusionDocumentSDKAssistant How to create and apply various conditional formats for different ranges? +{% endpromptcard %} +{% promptcard Export Data from Excel to Data Table %} +#SyncfusionDocumentSDKAssistant Show me how to export Excel data into collection objects using Export Data<>? +{% endpromptcard %} +{% promptcard Charts and PivotChart %} +#SyncfusionDocumentSDKAssistant Create a column chart from a data range with title, axis labels, and legend in Excel? +{% endpromptcard %} +{% promptcard Formula %} +#SyncfusionDocumentSDKAssistant How to create workbook-level named ranges and use them in formulas in Excel Components? +{% endpromptcard %} +{% promptcard Data Validation %} +#SyncfusionDocumentSDKAssistant Add dropdown list validation for a column using a named range? +{% endpromptcard %} +{% promptcard Table %} +#SyncfusionDocumentSDKAssistant Convert a range to an Excel Table with header row and banded style? +{% endpromptcard %} +{% promptcard Remove Encryption %} +#SyncfusionDocumentSDKAssistant How to remove a protection for an encrypted document for Excel Data? +{% endpromptcard %} +{% promptcard Drawing Objects and Shapes %} +#SyncfusionDocumentSDKAssistant Show the code for how to create a group shape in ASP.NET MVC for Excel Components? +{% endpromptcard %} +{% promptcard Excel to PDF %} +#SyncfusionDocumentSDKAssistant How to convert an entire Excel workbook to PDF? +{% endpromptcard %} +{% promptcard Chart to Image Conversion %} +#SyncfusionDocumentSDKAssistant How to convert an Excel chart to an image using the chart to image conversion class? +{% endpromptcard %} +{% endpromptcards %} + +### PowerPoint + +The Syncfusion PowerPoint Library enables developers to create, read, edit, and convert PowerPoint presentations programmatically across all .NET applications. + +{% promptcards %} +{% promptcard Create Presentation %} +#SyncfusionDocumentSDKAssistant How to programmatically create a new PowerPoint with slides, layouts, themes, and styled text? +{% endpromptcard %} +{% promptcard Edit and Save %} +#SyncfusionDocumentSDKAssistant How can I load an existing PPTX and save the updated presentation? +{% endpromptcard %} +{% promptcard Convert PowerPoint to PDF %} +#SyncfusionDocumentSDKAssistant How to convert a PowerPoint document into PDF document in .NET Core? +{% endpromptcard %} +{% promptcard Convert Slides to Images %} +#SyncfusionDocumentSDKAssistant Give an example that demonstrates the conversion of an entire Presentation to images? +{% endpromptcard %} +{% promptcard Create and Edit Charts %} +#SyncfusionDocumentSDKAssistant Show me how to insert charts, update data, and customize legends, axes, and data labels in PPTX? +{% endpromptcard %} +{% promptcard Convert Chart to Image %} +#SyncfusionDocumentSDKAssistant Is it possible to convert the charts in a Presentation slide to image? +{% endpromptcard %} +{% promptcard Create and Edit Animations %} +#SyncfusionDocumentSDKAssistant How do I apply and control entrance and emphasis animations with triggers and sequence ordering in Presentation? +{% endpromptcard %} +{% promptcard Create and Edit Transition Effects %} +#SyncfusionDocumentSDKAssistant Show how to set a transition effect to a PowerPoint slide? +{% endpromptcard %} +{% promptcard Create and Manage Comments %} +#SyncfusionDocumentSDKAssistant How can I insert, edit, and delete reviewer comments and list all comments in a presentation? +{% endpromptcard %} +{% promptcard Encrypt and Decrypt Presentations %} +#SyncfusionDocumentSDKAssistant Does PPTX support a password-protect with encryption and open a protected file? +{% endpromptcard %} +{% promptcard Create and Modify Sections %} +#SyncfusionDocumentSDKAssistant How can I create sections in PowerPoint? +{% endpromptcard %} +{% promptcard Clone and Merge %} +#SyncfusionDocumentSDKAssistant How to clone the slide collection of a section and add those slides to a destination presentation? +{% endpromptcard %} +{% promptcard Work with Tables %} +#SyncfusionDocumentSDKAssistant Show the code to apply the custom table formatting in presentation? +{% endpromptcard %} +{% promptcard Insert Shapes %} +#SyncfusionDocumentSDKAssistant Show how to insert shapes in presentation document? +{% endpromptcard %} +{% promptcard Insert PowerPoint Elements %} +#SyncfusionDocumentSDKAssistant Insert an image on a new slide, add a table, draw a shape, and place text inside the shape in the presentation document? +{% endpromptcard %} +{% endpromptcards %} + +### Spreadsheet + +The Syncfusion Spreadsheet Editor SDK component enables developers to create, view, edit, and analyze spreadsheets directly in web and desktop applications across multiple platforms, including Angular, React, Vue, JavaScript, Blazor, ASP.NET Core, and more. + +{% promptcards %} +{% promptcard Initialize Spreadsheet %} +#SyncfusionSpreadsheetEditorSDKAssistant How do I initialize a basic Spreadsheet in Angular with default settings? +{% endpromptcard %} +{% promptcard Data Binding %} +#SyncfusionSpreadsheetEditorSDKAssistant Show me how to bind local JSON data to the Spreadsheet in React? +{% endpromptcard %} +{% promptcard Remote Data Binding %} +#SyncfusionSpreadsheetEditorSDKAssistant Provide an example of binding remote data in a Vue Spreadsheet? +{% endpromptcard %} +{% promptcard Formulas and Calculation %} +#SyncfusionSpreadsheetEditorSDKAssistant How can I enable formula support and use named ranges in the TypeScript Spreadsheet? +{% endpromptcard %} +{% promptcard Charts %} +#SyncfusionSpreadsheetEditorSDKAssistant How do I insert and customize a column chart in the Blazor Spreadsheet? +{% endpromptcard %} +{% promptcard Data Validation %} +#SyncfusionSpreadsheetEditorSDKAssistant Provide an example of adding list validation to cells in TypeScript? +{% endpromptcard %} +{% promptcard Import and Export %} +#SyncfusionSpreadsheetEditorSDKAssistant How do I import an Excel file and export the Spreadsheet as XLSX in ASP.NET Core? +{% endpromptcard %} +{% promptcard Ribbon and Toolbar %} +#SyncfusionSpreadsheetEditorSDKAssistant Show how to customize the ribbon toolbar and add custom buttons in the ASP.NET MVC Spreadsheet? +{% endpromptcard %} +{% promptcard Grid Lines and Headers %} +#SyncfusionSpreadsheetEditorSDKAssistant How do I show or hide grid lines and row/column headers in the Windows Forms Spreadsheet? +{% endpromptcard %} +{% promptcard Sheet Protection %} +#SyncfusionSpreadsheetEditorSDKAssistant How can I protect a sheet with a password in the WPF Spreadsheet control? +{% endpromptcard %} +{% promptcard Conditional Formatting %} +#SyncfusionSpreadsheetEditorSDKAssistant How do I apply conditional formatting such as color scales or data bars in the UWP Spreadsheet? +{% endpromptcard %} +{% promptcard Cell Formatting %} +#SyncfusionSpreadsheetEditorSDKAssistant How do I apply cell styles, number formatting, and wrap text in the TypeScript Spreadsheet? +{% endpromptcard %} +{% promptcard Sorting and Filtering %} +#SyncfusionSpreadsheetEditorSDKAssistant Show me how to enable sorting and filtering features in the React Spreadsheet? +{% endpromptcard %} +{% endpromptcards %} + +## See also + +* [MCP Server Overview](../overview) +* [AI Coding Assistant Overview](./overview) +* [SyncfusionDocumentSDKAssistant MCP Server](https://www.npmjs.com/package/@syncfusion/documentsdk-assistant) +* [SyncfusionSpreadsheetEditorSDKAssistant MCP Server](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) diff --git a/Document-Processing/mcp-server/overview.md b/Document-Processing/mcp-server/overview.md new file mode 100644 index 0000000000..1fb0ac5419 --- /dev/null +++ b/Document-Processing/mcp-server/overview.md @@ -0,0 +1,74 @@ +--- +layout: post +title: Overview of MCP Server – Syncfusion +description: Get a quick overview of Syncfusion’s MCP Server, designed to enable seamless document processing, AI-driven workflows, and efficient prompt-based interactions +platform: document-processing +control: MCP Server +documentation: ug +--- + +# Syncfusion® MCP Server Overview + +Syncfusion® MCP Server accelerates document processing by providing deep knowledge directly in your AI-powered IDE. Through Model Context Protocol (MCP) integration, you get instant access to Document Processing APIs, pre-built templates, formatting configurations, and code generation - all without leaving your development environment. + +Use these tools to speed up document automation workflows and follow best practices when creating, converting, or processing documents. + +## Key Benefits + +* **Expert Document Knowledge** - Deep understanding of Word, Excel, PowerPoint, and PDF processing with their implementation patterns. +* **Design System Integration** - Guidance for styling documents with proper formatting, tables, charts, and visual elements. +* **Pre-Built Templates** - Ready-to-use document templates for rapid document generation. +* **Format Support** - Comprehensive support for DOCX, XLSX, PPTX, PDF, CSV, and other popular formats. +* **Unlimited Usage** - No request limits, time restrictions, or query caps. +* **Privacy-Focused** - Your data remains secure. The tools do not access files, store data, or use your prompts for training purposes. + +## How it Works + +Syncfusion MCP Servers are delivered as .NET-based Model Context Protocol (MCP) servers that integrate seamlessly with AI-powered development environments. The server provides specialized tools tailored for document processing workflows: + +**AI Coding Assistant** - Implement document processing features with focused API guidance. Ideal for adding document automation to existing projects and troubleshooting integration issues. + +**Available MCP Servers** + +* SyncfusionDocumentSDKAssistant +* SyncfusionDOCXEditorSDKAssistant +* SyncfusionSpreadsheetEditorSDKAssistant +* SyncfusionPDFViewerSDKAssistant + +## Unlimited Access + +Syncfusion provides unlimited access to the MCP server with no restrictions on: + +* Number of requests +* Tool usage +* Query caps +* Usage duration + +This unlimited access empowers you to experiment freely, iterate rapidly, and fully leverage the tool's capabilities throughout your development life cycle. + +## Best Practices + +For optimal results, use high-performance AI models like Claude Sonnet 4.5 (recommended), GPT-5, or Gemini 3 Pro. These models understand complex document structures better and generate more accurate document processing code. + +> Always review AI-generated code before using it in production. + +## Privacy & Security + +The Syncfusion MCP Servers are designed with privacy considerations: + +* The tools do not access project files or workspace contents directly. +* User prompts are not stored or used for other purposes. +* Prompts are not used to train Syncfusion models. +* The assistant provides context; the final output is produced by the selected AI model. + +The MCP Server acts purely as a knowledge bridge, connecting your AI model with Syncfusion-specific expertise while respecting your privacy and maintaining security. + +## See Also + +* [AI Coding Assistant Overview](./ai-coding-assistant/overview) +* [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro) + + + + + diff --git a/Document-Processing/mcp-server/documentsdk-mcp.md b/Document-Processing/mcp.md similarity index 97% rename from Document-Processing/mcp-server/documentsdk-mcp.md rename to Document-Processing/mcp.md index 4464ceed12..624364651e 100644 --- a/Document-Processing/mcp-server/documentsdk-mcp.md +++ b/Document-Processing/mcp.md @@ -9,7 +9,7 @@ documentation: ug # Syncfusion Document SDK MCP Server -Syncfusion® Document SDK MCP Server accelerates document processing application development by providing deep knowledge directly in your AI-powered IDE. [Model Context Protocol](https://modelcontextprotocol.io/docs/2026-07-28/getting-started/intro) (MCP) integration enables quick access to documentation, API references, and code-generation features from within the development environment. +Syncfusion® Document SDK MCP Server accelerates document processing application development by providing deep knowledge directly in your AI-powered IDE. [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro) (MCP) integration enables quick access to documentation, API references, and code-generation features from within the development environment. These tools speed up development and reinforce best practices for Syncfusion document processing libraries integration. @@ -262,4 +262,4 @@ The MCP Server acts purely as a knowledge bridge, connecting your AI model with ## See also -- [Model Context Protocol](https://modelcontextprotocol.io/docs/2026-07-28/getting-started/intro) \ No newline at end of file +- [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro) \ No newline at end of file