diff --git a/Document-Processing/ai-coding-assistant/mcp-server.md b/Document-Processing/ai-coding-assistant/MCP Server/documentsdk.md similarity index 85% rename from Document-Processing/ai-coding-assistant/mcp-server.md rename to Document-Processing/ai-coding-assistant/MCP Server/documentsdk.md index baf82dbe7..dca89023a 100644 --- a/Document-Processing/ai-coding-assistant/mcp-server.md +++ b/Document-Processing/ai-coding-assistant/MCP Server/documentsdk.md @@ -55,30 +55,11 @@ Before you can invoke the ```SyncfusionDocumentSDKAssistant``` MCP server, you n * **Arguments**: -y * **Server name**: syncfusionDocumentSDKAssistant -#### API Key Configuration +You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file: -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" + "env": { + "Syncfusion_API_Key": "YOUR_API_KEY" } ~~~ @@ -108,8 +89,6 @@ For additional details, see the Code Studio [documentation](https://help.syncfus "@syncfusion/documentsdk-assistant@latest" ], "env": { - "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", - // or "Syncfusion_API_Key": "YOUR_API_KEY" } } @@ -117,7 +96,7 @@ For additional details, see the Code Studio [documentation](https://help.syncfus } ~~~ - * After updating the configuration in mcp.json, you’ll notice a “Start” option at the top of the config. This allows you to easily start the SyncfusionDocumentSDKAssistant server directly from the settings interface without additional commands. + * After updating the configuration in settings.json, you’ll notice a “Start” option at the top of the config. This allows you to easily start the SyncfusionDocumentSDKAssistant server directly from the settings interface without additional commands. * Confirm that SyncfusionDocumentSDKAssistant is being used (this does not happen automatically). Look for a statement in the output, which is similar to: @@ -139,8 +118,6 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc "@syncfusion/documentsdk-assistant@latest" ], "env": { - "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", - // or "Syncfusion_API_Key": "YOUR_API_KEY" } } @@ -165,8 +142,6 @@ For more details, refer to 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 + +You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file: + +```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": "YOUR_API_KEY" + } + } + } + } + ``` + +* After updating the configuration in settings.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the [SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) 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": "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": "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/ai-coding-assistant/overview.md b/Document-Processing/ai-coding-assistant/overview.md index f60787ad0..ba7267e6d 100644 --- a/Document-Processing/ai-coding-assistant/overview.md +++ b/Document-Processing/ai-coding-assistant/overview.md @@ -10,13 +10,13 @@ documentation: ug # Syncfusion® AI Coding Assistant Overview -The **Syncfusion® AI Coding Assistant** are designed to streamline your development workflow when building .NET applications with Syncfusion® components. It uses contextual knowledge of the Syncfusion® component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. - +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 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 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 across multiple platforms, including ASP.NET Core, ASP.NET MVC, Angular, React, Vue, JavaScript (ES5/ES6), UWP, Windows Forms, WPF, and Blazor. ## Getting Started @@ -28,7 +28,7 @@ To use the AI Coding Assistant, you need: * [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 .NET application that includes Syncfusion Document Processing libraries + * Any project setup that includes Syncfusion® components ## Unlimited Access @@ -43,10 +43,10 @@ This ensures users can fully leverage Syncfusion® components to e ## Best Practices - * Initial Setup: Use the tools to quickly add and configure Syncfusion® components in your .NET applications. + * Initial Setup: Use the tools to quickly add and configure Syncfusion® components in your applications. * Feature Tuning: Enable or disable component features through prompt-based configuration for tailored functionality. * Data Binding: Generate sample data for testing and prototyping. Avoid using sensitive or production data to ensure security. - * Step-by-step explanations: Use annotated code to understand component behavior. Note that the level of detail may vary depending on the tool, mode, and AI model used. Refer to the [Syncfusion® Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) for in-depth information. + * Step-by-step explanations: Use annotated code to understand component behavior. Note that the level of detail may vary depending on the tool, mode, and AI model used. Refer to the [Syncfusion® Document Processing Documentation](https://help.syncfusion.com/document-processing/introduction) for in-depth information. * Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, refer to [documentation](https://help.syncfusion.com/document-processing/introduction) or [support](https://support.syncfusion.com/support/tickets/create). >Always check AI-generated content and code for accuracy before using it. @@ -67,8 +67,10 @@ The Syncfusion® AI Coding Assistant is designed with privacy in m ## See also - * Add the SyncfusionDocumentSDKAssistant MCP Server to an MCP-enabled client + * Add the SyncfusionDocumentSDKAssistant MCP Server to an MCP-enabled client + * Add the SyncfusionSpreadsheetEditorSDKAssistant MCP Server to an MCP-enabled client * [Syncfusion® Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) + * [Syncfusion® SpreadsheetEditor SDK Documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/overview) diff --git a/Document-Processing/ai-coding-assistant/prompt-library.md b/Document-Processing/ai-coding-assistant/prompt-library.md index 84d360e59..cccb9412a 100644 --- a/Document-Processing/ai-coding-assistant/prompt-library.md +++ b/Document-Processing/ai-coding-assistant/prompt-library.md @@ -10,14 +10,14 @@ domainurl: ##DomainURL## # Prompt Library - AI Coding Assistant -Speed up your projects using these ready-made prompts for Syncfusion® Document Processing libraries. Each prompt is short, easy to understand, and focused on real tasks—like quick setups, tweaks, and fixes. +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 #SyncfusionDocumentSDKAssistant handle. +* 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. @@ -226,7 +226,54 @@ The Syncfusion PowerPoint Library enables developers to create, read, edit, and {% 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 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 in cells in Typescript? +{% endpromptcard %} +{% promptcard Import and Export %} +#SyncfusionSpreadsheetEditorSDKAssistant How to 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 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 to apply conditional formatting such as color scales or data bars in UWP Spreadsheet? +{% endpromptcard %} +{% promptcard Cell Formatting %} +#SyncfusionSpreadsheetEditorSDKAssistant How to 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 * [AI Coding Assistant Overview](https://help.syncfusion.com/document-processing/ai-coding-assistant/overview) * [SyncfusionDocumentSDKAssistant MCP Server](https://help.syncfusion.com/document-processing/ai-coding-assistant/mcp-server) +* [SyncfusionSpreadsheetEditorSDKAssistant MCP Server](https://help.syncfusion.com/document-processing/ai-coding-assistant/mcp-server) \ No newline at end of file