|
| 1 | +--- |
| 2 | +layout: post |
| 3 | +title: SyncfusionAspNetCoreAssistant MCP Server | Syncfusion |
| 4 | +description: Learn how to configure and use SyncfusionAspNetCoreAssistant MCP server for code generation, documentation, and troubleshooting in ASP.NET Core apps. |
| 5 | +control: Getting started with SyncfusionAspNetCoreAssistant MCP Server |
| 6 | +platform: ej2-asp-core-mvc |
| 7 | +publishingplatform: ##Platform_Name## |
| 8 | +documentation: ug |
| 9 | +--- |
| 10 | + |
| 11 | +# SyncfusionAspNetCoreAssistant MCP Server |
| 12 | + |
| 13 | +## Overview |
| 14 | + |
| 15 | +The [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant) is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion's ASP.NET Core controls. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building ASP.NET Core applications with Syncfusion<sup style="font-size:70%">®</sup> controls. |
| 16 | + |
| 17 | +### Key Benefits |
| 18 | + |
| 19 | +* Intelligent code generation for Syncfusion<sup style="font-size:70%">®</sup> ASP.NET Core controls. |
| 20 | +* Detailed documentation and usage examples. |
| 21 | +* Troubleshooting assistance for common integration challenges. |
| 22 | + |
| 23 | +## Prerequisites |
| 24 | + |
| 25 | +Before using [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant), ensure you have: |
| 26 | + |
| 27 | +* Required [node](https://nodejs.org/en/) version >= 18 |
| 28 | +* A [compatible MCP client](https://modelcontextprotocol.io/clients) (Visual Studio 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 | +* Controls usage |
| 41 | +* Query caps |
| 42 | +* Usage duration |
| 43 | + |
| 44 | +This ensures users can fully leverage Syncfusion<sup style="font-size:70%">®</sup> controls to enhance their development experience without limitations. |
| 45 | + |
| 46 | +## Installation and setup |
| 47 | + |
| 48 | +Before you can invoke the `SyncfusionAspNetCoreAssistant` 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/aspnetcore-assistant` |
| 53 | +- **Type**: stdio (standard input/output transport) |
| 54 | +- **Command**: npx |
| 55 | +- **Arguments**: -y |
| 56 | +- **Server name**: syncfusionAspNetCoreAssistant |
| 57 | + |
| 58 | +You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file: |
| 59 | + |
| 60 | +```json |
| 61 | +"env": { |
| 62 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 63 | +} |
| 64 | +``` |
| 65 | + |
| 66 | +Below are setup instructions for popular MCP clients: |
| 67 | + |
| 68 | +### Syncfusion<sup style="font-size:70%">®</sup> Code Studio |
| 69 | + |
| 70 | +* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the `Custom Servers` tab. |
| 71 | +* Enter the Server Name as `aspnetcore-mcp`, choose Server Type as npm package, and set the NPM Package name to `@syncfusion/aspnetcore-assistant`. |
| 72 | +* 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**. |
| 73 | +* Once installed, the server will appear in the User Installed Server list, and will be added to the **config.yaml** file. |
| 74 | +* 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#npm-server). |
| 75 | + |
| 76 | +### Visual Studio Code (GitHub Copilot MCP) |
| 77 | + |
| 78 | +* To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder. |
| 79 | + |
| 80 | +```json |
| 81 | +{ |
| 82 | + "servers": { |
| 83 | + "syncfusion-aspnetcore-assistant": { |
| 84 | + "type": "stdio", |
| 85 | + "command": "npx", |
| 86 | + "args": [ |
| 87 | + "-y", |
| 88 | + "@syncfusion/aspnetcore-assistant@latest" |
| 89 | + ], |
| 90 | + "env": { |
| 91 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 92 | + } |
| 93 | + } |
| 94 | + } |
| 95 | +} |
| 96 | +``` |
| 97 | + |
| 98 | +* 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 [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant) server directly from the settings interface without additional commands. |
| 99 | + |
| 100 | +* Confirm the server is active by checking for a message like: `SyncfusionAspNetCoreAssistant is running...` in the output. |
| 101 | + |
| 102 | +* For additional guidance, refer to the [Visual Studio Code documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server). |
| 103 | + |
| 104 | +### Visual Studio (GitHub Copilot MCP) |
| 105 | + |
| 106 | +* To configure an MCP server for a specific workspace, you can create a `.vs/mcp.json` file in your workspace folder. |
| 107 | + |
| 108 | +```json |
| 109 | +{ |
| 110 | + "servers": { |
| 111 | + "syncfusion-aspnetcore-assistant": { |
| 112 | + "type": "stdio", |
| 113 | + "command": "npx", |
| 114 | + "args": [ |
| 115 | + "-y", |
| 116 | + "@syncfusion/aspnetcore-assistant@latest" |
| 117 | + ], |
| 118 | + "env": { |
| 119 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 120 | + } |
| 121 | + } |
| 122 | + } |
| 123 | +} |
| 124 | +``` |
| 125 | + |
| 126 | +* After updating the mcp.json configuration, open the GitHub Copilot Chat window. Click the Ask arrow, then select Agent. |
| 127 | +* Select the [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant) from the tools section. |
| 128 | +* For more details, refer to the official [Visual Studio documentation](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022). |
| 129 | + |
| 130 | +### Cursor |
| 131 | + |
| 132 | +To configure an MCP server for a specific workspace, you can create a `.cursor/mcp.json` file in your workspace folder. |
| 133 | + |
| 134 | +```json |
| 135 | +{ |
| 136 | + "mcpServers": { |
| 137 | + "syncfusion-aspnetcore-assistant": { |
| 138 | + "type": "stdio", |
| 139 | + "command": "npx", |
| 140 | + "args": [ |
| 141 | + "-y", |
| 142 | + "@syncfusion/aspnetcore-assistant@latest" |
| 143 | + ], |
| 144 | + "env": { |
| 145 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | +} |
| 150 | +``` |
| 151 | + |
| 152 | +For more details, refer to the [Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-json). |
| 153 | + |
| 154 | +### JetBrains IDEs |
| 155 | + |
| 156 | +* Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP). |
| 157 | +* Click + Add to add a new MCP server configuration. |
| 158 | +* In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config: |
| 159 | + |
| 160 | +```json |
| 161 | +{ |
| 162 | + "mcpServers": { |
| 163 | + "syncfusion-aspnetcore-assistant": { |
| 164 | + "command": "npx.cmd", |
| 165 | + "args": [ |
| 166 | + "-y", |
| 167 | + "@syncfusion/aspnetcore-assistant@latest" |
| 168 | + ], |
| 169 | + "env": { |
| 170 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 171 | + } |
| 172 | + } |
| 173 | + } |
| 174 | +} |
| 175 | +``` |
| 176 | + |
| 177 | +* Click OK and Apply. |
| 178 | + |
| 179 | +For further assistance, see the [JetBrains documentation](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server). |
| 180 | + |
| 181 | +> 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) |
| 182 | +
|
| 183 | +## Usage |
| 184 | + |
| 185 | +To activate the SyncfusionAspNetCoreAssistant MCP server: |
| 186 | + |
| 187 | +1. Start your prompt with one of the following: |
| 188 | + * 'SyncfusionAspNetCoreAssistant' |
| 189 | + * '/syncfusion-aspnetcore-assistant' |
| 190 | + * '/syncfusion-aspnetcore' |
| 191 | + * '@syncfusion-aspnetcore' |
| 192 | + * '@ask_syncfusion_aspnetcore' |
| 193 | + * 'ej2-aspnetcore' |
| 194 | + |
| 195 | + In Visual Studio Code, you can also use #SyncfusionAspNetCoreAssistant to explicitly invoke the MCP server. |
| 196 | + |
| 197 | +2. Grant permission for the server to run (for the 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 control (e.g., "How do I create a Syncfusion ASP.NET Core Grid with paging and filtering?"). |
| 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 controls or topics. |
| 210 | + |
| 211 | +### Example Queries |
| 212 | + |
| 213 | +Here are some effective ways to use [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant): |
| 214 | + |
| 215 | + * "Create a Syncfusion ASP.NET Core Grid control with paging, sorting and filtering" |
| 216 | + * "How do I implement data binding with Syncfusion ASP.NET Core scheduler?" |
| 217 | + * "Show me how to create a dashboard with multiple Syncfusion controls" |
| 218 | + |
| 219 | +## Troubleshooting |
| 220 | + |
| 221 | +If you encounter issues: |
| 222 | + |
| 223 | + * Verify your API key is correctly configured. |
| 224 | + * Ensure the MCP server is enabled in your client's tools selection. |
| 225 | + * Check that you're using a compatible MCP client version. |
| 226 | + * Try restarting your development environment. |
| 227 | + |
| 228 | +## Support |
| 229 | + |
| 230 | +Product support is available through the following mediums. |
| 231 | + |
| 232 | +* [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours \| Unlimited tickets \| Holiday support |
| 233 | +* [Community forum](https://www.syncfusion.com/forums/aspnetcore-js2) |
| 234 | +* [Request feature or report bug](https://www.syncfusion.com/feedback/aspnet-core) |
| 235 | +* Live chat |
| 236 | + |
| 237 | +## See also |
| 238 | + |
| 239 | +* [Syncfusion ASP.NET Core Documentation](https://ej2.syncfusion.com/aspnetcore/documentation/getting-started/razor-pages) |
0 commit comments