SyncfusionAspNetCoreAssistant MCP Server
3 Nov 20257 minutes to read
Overview
The SyncfusionAspNetCoreAssistant is a specialized Model Context Protocol (MCP) server that provides intelligent assistance for developers using Syncfusion’s ASP.NET Core controls. This tool seamlessly integrates with compatible MCP clients to enhance your development workflow when building ASP.NET Core applications with Syncfusion® controls.
Key Benefits
- Intelligent code generation for Syncfusion® ASP.NET Core controls.
- Detailed documentation and usage examples.
- Troubleshooting assistance for common integration challenges.
Prerequisites
Before using SyncfusionAspNetCoreAssistant, ensure you have:
- Required node version >= 18
- A compatible MCP client (Visual Studio Code with GitHub Copilot, Syncfusion® CodeStudio, etc.)
- An active Syncfusion® license (any of the following):
- An active API KEY
Unlimited Access
Syncfusion® offers unlimited access to this MCP server. There are no restrictions on:
- Number of requests
- Controls usage
- Query caps
- Usage duration
This ensures users can fully leverage Syncfusion® controls to enhance their development experience without limitations.
Installation and setup
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:
Generic MCP Server Settings
-
npm package name:
@syncfusion/aspnetcore-assistant - Type: stdio (standard input/output transport)
- Command: npx
- Arguments: -y
- Server name: syncfusionAspNetCoreAssistant
You need to add your Syncfusion API key as an env parameter in the configuration file:
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}Below are setup instructions for popular MCP clients:
Syncfusion® Code Studio
- In Code Studio, open MCP Marketplace and navigate to the
Custom Serverstab. - Enter the Server Name as
aspnetcore-mcp, choose Server Type as npm package, and set the NPM Package name to@syncfusion/aspnetcore-assistant. - Add an environment variable as
Syncfusion_API_Keyand value as your Syncfusion 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.
Visual Studio Code (GitHub Copilot MCP)
- To configure an MCP server for a specific workspace, you can create a
.vscode/mcp.jsonfile in your workspace folder.
{
"servers": {
"syncfusion-aspnetcore-assistant": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@syncfusion/aspnetcore-assistant@latest"
],
"env": {
"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 SyncfusionAspNetCoreAssistant server directly from the settings interface without additional commands.
-
Confirm the server is active by checking for a message like:
SyncfusionAspNetCoreAssistant is running...in the output. -
For additional guidance, refer to the Visual Studio Code documentation.
Visual Studio (GitHub Copilot MCP)
- To configure an MCP server for a specific workspace, you can create a
.vs/mcp.jsonfile in your workspace folder.
{
"servers": {
"syncfusion-aspnetcore-assistant": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@syncfusion/aspnetcore-assistant@latest"
],
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}- After updating the mcp.json configuration, open the GitHub Copilot Chat window. Click the Ask arrow, then select Agent.
- Select the SyncfusionAspNetCoreAssistant from the tools section.
- 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.
{
"mcpServers": {
"syncfusion-aspnetcore-assistant": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@syncfusion/aspnetcore-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 JSONand add the following config:
{
"mcpServers": {
"syncfusion-aspnetcore-assistant": {
"command": "npx.cmd",
"args": [
"-y",
"@syncfusion/aspnetcore-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
Usage
To activate the SyncfusionAspNetCoreAssistant MCP server:
- Start your prompt with one of the following:
- ‘SyncfusionAspNetCoreAssistant’
- ‘/syncfusion-aspnetcore-assistant’
- ‘/syncfusion-aspnetcore’
- ‘@syncfusion-aspnetcore’
- ‘@ask_syncfusion_aspnetcore’
- ‘ej2-aspnetcore’
In Visual Studio Code, you can also use #SyncfusionAspNetCoreAssistant to explicitly invoke the MCP server.
- Grant permission for the server to run (for the session, workspace, or always).
- 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
-
Be specific: Mention both platform and control (e.g., “How do I create a Syncfusion ASP.NET Core Grid with paging and filtering?”). -
Provide context: Include details about your use case for more targeted solutions. -
Use descriptive queries: Avoid vague questions that lack necessary context. -
Start fresh for new topics: Begin a new chat session when switching controls or topics.
Example Queries
Here are some effective ways to use SyncfusionAspNetCoreAssistant:
- “Create a Syncfusion ASP.NET Core Grid control with paging, sorting and filtering”
- “How do I implement data binding with Syncfusion ASP.NET Core scheduler?”
- “Show me how to create a dashboard with multiple Syncfusion controls”
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 - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
- Community forum
- Request feature or report bug
- Live chat