|
| 1 | +--- |
| 2 | +layout: post |
| 3 | +title: SyncfusionSpreadsheetEditorSDKAssistant MCP Server Setup – Syncfusion |
| 4 | +description: Explore the MCP server’s benefits, setup needs, and integration guidance for Syncfusion SpreadsheetEditorSDK. |
| 5 | +platform: document-processing |
| 6 | +control: AI coding assistant |
| 7 | +documentation: ug |
| 8 | +--- |
| 9 | + |
| 10 | +# SyncfusionSpreadsheetEditorSDKAssistant MCP Server |
| 11 | + |
| 12 | +## Overview |
| 13 | + |
| 14 | +The <a href ="https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant">SyncfusionSpreadsheetEditorSDKAssistant</a> 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. |
| 15 | +It integrates seamlessly with [MCP clients](https://modelcontextprotocol.io/clients) to provide intelligent assistance for building applications with Syncfusion<sup style="font-size:70%">®</sup> components. |
| 16 | + |
| 17 | +### Key Benefits |
| 18 | + |
| 19 | +- Instant code generation & explanations for Syncfusion<sup style="font-size:70%">®</sup> SpreadsheetEditorSDK component. |
| 20 | +- Detailed component documentation and usage examples. |
| 21 | +- Troubleshooting assistance for common integration challenges. |
| 22 | + |
| 23 | +## Prerequisites |
| 24 | + |
| 25 | +Before using <a href="https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant">SyncfusionSpreadsheetEditorSDKAssistant</a>, ensure you have: |
| 26 | + |
| 27 | +* Required [node](https://nodejs.org/en/) version >= 18 |
| 28 | +* A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion<sup style="font-size:70%">®</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.) |
| 29 | +* An active Syncfusion<sup style="font-size:70%">®</sup> license (any of the following): |
| 30 | + - [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense) |
| 31 | + - [Free Community License](https://www.syncfusion.com/products/communitylicense) |
| 32 | + - [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials) |
| 33 | +* An active [API KEY](https://syncfusion.com/account/api-key) |
| 34 | + |
| 35 | +## Unlimited Access |
| 36 | + |
| 37 | +Syncfusion<sup style="font-size:70%">®</sup> offers unlimited access to this MCP server. There are no restrictions on: |
| 38 | + |
| 39 | +* Number of requests |
| 40 | +* Components usage |
| 41 | +* Query types |
| 42 | +* Usage duration |
| 43 | + |
| 44 | +This ensures users can fully leverage Syncfusion<sup style="font-size:70%">®</sup> components to enhance their development experience without limitations. |
| 45 | + |
| 46 | +## Installation and setup |
| 47 | + |
| 48 | +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: |
| 49 | + |
| 50 | +### Generic MCP Server Settings |
| 51 | + |
| 52 | +- **npm package name**: ```@syncfusion/spreadsheeteditorsdk-assistant``` |
| 53 | +- **Type**: stdio (standard input/output transport) |
| 54 | +- **Command**: npx |
| 55 | +- **Arguments**: -y |
| 56 | +- **Server name**: syncfusionSpreadsheetEditorSDKAssistant |
| 57 | + |
| 58 | +#### API Key Configuration |
| 59 | + |
| 60 | +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. |
| 61 | + |
| 62 | +There are two options: |
| 63 | + |
| 64 | +* **Using an API Key File (Recommended)** |
| 65 | + |
| 66 | + 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. |
| 67 | + |
| 68 | + **Supported file formats:** `.txt` or `.key` file |
| 69 | + |
| 70 | +~~~json |
| 71 | + "env": { |
| 72 | + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key" |
| 73 | + } |
| 74 | +~~~ |
| 75 | +* **Direct API Key** |
| 76 | + |
| 77 | + Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter. |
| 78 | + |
| 79 | +~~~json |
| 80 | + "env": { |
| 81 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 82 | + } |
| 83 | +~~~ |
| 84 | + |
| 85 | +[SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) can be configured in various MCP clients. Below are setup instructions for popular environment: |
| 86 | + |
| 87 | +### Syncfusion<sup>®</sup> Code Studio |
| 88 | + |
| 89 | + * In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the ```Custom Servers``` tab. |
| 90 | + * Enter the Server Name as ```spreadsheeteditorsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/spreadsheeteditorsdk-assistant```. |
| 91 | + * 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**. |
| 92 | + * Once installed, the server will appear in the User Installed Server list and will be added to the **config.yaml** file. |
| 93 | + * 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). |
| 94 | + |
| 95 | +For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers). |
| 96 | + |
| 97 | +### VS Code (GitHub Copilot MCP) |
| 98 | + |
| 99 | +* To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder. |
| 100 | + |
| 101 | + ```json |
| 102 | + { |
| 103 | + "servers": { |
| 104 | + "syncfusion-spreadsheeteditorsdk-assistant": { |
| 105 | + "type": "stdio", |
| 106 | + "command": "npx", |
| 107 | + "args": [ |
| 108 | + "-y", |
| 109 | + "@syncfusion/spreadsheeteditorsdk-assistant@latest" |
| 110 | + ], |
| 111 | + "env": { |
| 112 | + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", |
| 113 | + // or |
| 114 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 115 | + } |
| 116 | + } |
| 117 | + } |
| 118 | + } |
| 119 | + ``` |
| 120 | + |
| 121 | +* After updating the configuration in mcp.json, you’ll notice a “Start” option at the top of the config. This allows you to easily start the <a href ="https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant">SyncfusionSpreadsheetEditorSDKAssistant</a> server directly from the settings interface without additional commands. |
| 122 | + |
| 123 | +* 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: |
| 124 | + * ```SyncfusionSpreadsheetEditorSDKAssistant is running...``` (in VS Code) |
| 125 | + |
| 126 | +* For more details, refer to the official <a href = "https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022"> Visual Studio documentation</a>. |
| 127 | + |
| 128 | +### Cursor |
| 129 | + |
| 130 | +To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder. |
| 131 | + |
| 132 | +```json |
| 133 | +{ |
| 134 | + "mcpServers": { |
| 135 | + "syncfusion-spreadsheeteditorsdk-assistant": { |
| 136 | + "type": "stdio", |
| 137 | + "command": "npx", |
| 138 | + "args": [ |
| 139 | + "-y", |
| 140 | + "@syncfusion/spreadsheeteditorsdk-assistant@latest" |
| 141 | + ], |
| 142 | + "env": { |
| 143 | + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", |
| 144 | + // or |
| 145 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | +} |
| 150 | +``` |
| 151 | +For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp#using-mcp-json">Cursor documentation</a>. |
| 152 | + |
| 153 | +### JetBrains IDEs |
| 154 | + |
| 155 | +* Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP). |
| 156 | +* Click + Add to add a new MCP server configuration. |
| 157 | +* In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config: |
| 158 | + |
| 159 | +```json |
| 160 | +{ |
| 161 | + "mcpServers": { |
| 162 | + "syncfusion-spreadsheeteditorsdk-assistant": { |
| 163 | + "command": "npx", |
| 164 | + "args": [ |
| 165 | + "-y", |
| 166 | + "@syncfusion/spreadsheeteditorsdk-assistant@latest" |
| 167 | + ], |
| 168 | + "env": { |
| 169 | + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH", |
| 170 | + // or |
| 171 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 172 | + } |
| 173 | + } |
| 174 | + } |
| 175 | +} |
| 176 | +``` |
| 177 | + |
| 178 | +* Click OK and Apply. |
| 179 | + |
| 180 | +For further assistance, see the <a href ="https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server">JetBrains documentation</a>. |
| 181 | + |
| 182 | +> 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) |
| 183 | +
|
| 184 | +## Usage |
| 185 | + |
| 186 | +To activate the SyncfusionSpreadsheetEditorSDKAssistant MCP server: |
| 187 | + |
| 188 | +1. Start your prompt with one of the following: |
| 189 | + * 'SyncfusionSpreadsheetEditorSDKAssistant' |
| 190 | + * '/syncfusion-spreadsheeteditorsdk-assistant' |
| 191 | + * '/syncfusion-spreadsheeteditorsdk' |
| 192 | + * '@syncfusion-spreadsheeteditorsdk' |
| 193 | + * '@ask_syncfusion_spreadsheeteditorsdk' |
| 194 | + |
| 195 | + In VS Code, you can also use #SyncfusionSpreadsheetEditorSDKAssistant to explicitly invoke the MCP server. |
| 196 | + |
| 197 | +2. Grant the SyncfusionSpreadsheetEditorSDKAssistant MCP server a permission to run for this session, workspace, or always. |
| 198 | +3. For best results, start a new chat for each new topic to maintain clean context. |
| 199 | + |
| 200 | +### Mode availability |
| 201 | + |
| 202 | +Syncfusion<sup style="font-size:70%">®</sup> MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients. |
| 203 | + |
| 204 | +### Best Practices for Effective Usage |
| 205 | + |
| 206 | +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?"). |
| 207 | +2. ```Provide context```: Include details about your use case for more targeted solutions. |
| 208 | +3. ```Use descriptive queries```: Avoid vague questions that lack necessary context. |
| 209 | +4. ```Start fresh for new topics```: Begin a new chat session when switching components or topics. |
| 210 | + |
| 211 | +### Example Queries |
| 212 | + |
| 213 | +Here are some effective ways to use [SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant): |
| 214 | + |
| 215 | + * "Provide TypeScript examples of using VLOOKUP and SUMIF formulas in Syncfusion Spreadsheet." |
| 216 | + * "Show me how to perform data validation with dropdown lists in Vue Spreadsheet." |
| 217 | + * "How do I merge cells and apply borders programmatically in ASP.NET Core Spreadsheet?" |
| 218 | + * "Explain how to enable virtual scrolling in Syncfusion EJ2 Spreadsheet with large datasets." |
| 219 | + * "How can I protect specific sheets and lock certain ranges in Syncfusion Spreadsheet for MVC?" |
| 220 | + |
| 221 | +## Troubleshooting |
| 222 | + |
| 223 | +If you encounter issues: |
| 224 | + |
| 225 | + * Verify your API key is correctly configured. |
| 226 | + * Ensure the MCP server is enabled in your client's tools selection. |
| 227 | + * Check that you're using a compatible MCP client version. |
| 228 | + * Try restarting your development environment. |
| 229 | + |
| 230 | +## Support |
| 231 | + |
| 232 | +Product support is available through the following mediums. |
| 233 | + |
| 234 | +* [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support |
| 235 | +* [Community forum](https://www.syncfusion.com/forums/spreadsheet-editor-sdk) |
| 236 | +* [Request feature or report bug](https://www.syncfusion.com/feedback/spreadsheet-editor-sdk) |
| 237 | +* Live chat |
| 238 | + |
| 239 | +## See also |
| 240 | + |
| 241 | + * [Syncfusion SpreadsheetEditorSDK Documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/overview) |
0 commit comments