From 5d2baa00c071a80e92339a7665b5f40e216cba71 Mon Sep 17 00:00:00 2001 From: Arun Kumar Ragu Date: Thu, 23 Oct 2025 13:46:14 +0530 Subject: [PATCH 1/9] 988638: Updated the docs for usage of MCP Server --- .../ai-coding-assistants/mcp-server.md | 240 ++++++++++++++++++ .../ai-coding-assistants/overview.md | 70 +++++ .../EJ2_ASP.NETCORE/introduction.md | 2 + ej2-asp-core-toc.html | 6 + 4 files changed, 318 insertions(+) create mode 100644 ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/mcp-server.md create mode 100644 ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/overview.md diff --git a/ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/mcp-server.md b/ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/mcp-server.md new file mode 100644 index 0000000000..660d0b40d4 --- /dev/null +++ b/ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/mcp-server.md @@ -0,0 +1,240 @@ +--- +layout: post +title: SyncfusionAspNetCoreAssistant MCP Server | Syncfusion +description: Learn how to configure and use SyncfusionAspNetCoreAssistant MCP server for intelligent code generation, documentation, and troubleshooting in ASP.NET Core apps. +control: Getting started with SyncfusionAspNetCoreAssistant MCP Server +platform: ej2-asp-core-mvc +publishingplatform: ##Platform_Name## +documentation: ug +--- + +# SyncfusionAspNetCoreAssistant MCP Server + +## Overview + +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® 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](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant), ensure you have: + +* Required [node](https://nodejs.org/en/) version >= 18 +* A [compatible MCP client](https://modelcontextprotocol.io/clients) (Visual Studio 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® 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](https://syncfusion.com/account/api-key) as an env parameter in the configuration file: + +```json +"env": { + "Syncfusion_API_Key": "YOUR_API_KEY" +} +``` + +[SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-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, find `SyncfusionAspNetCoreAssistant`, and click Install. +* When prompted, enter your [Syncfusion API key](https://syncfusion.com/account/api-key) and click Submit to register. +* It installs locally on your machine and appears in the Installed list. +* The server is ready for use in Code Studio. + +For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/marketplace). + +### Visual Studio Code (GitHub Copilot MCP) + +1. To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder. + +```json +{ + "servers": { + "syncfusion-aspnetcore-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/aspnetcore-assistant@latest" + ], + "env": { + "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} +``` + +2. 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 [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant) server directly from the settings interface without additional commands. + +3. Confirm that [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant) is being used (this does not happen automatically). Look for a statement in the output, which is similar to: + * `SyncfusionAspNetCoreAssistant is running...` (in Visual Studio Code) + +### Visual Studio (GitHub Copilot MCP) + +* To configure an MCP server for a specific workspace, you can create a `.vs/mcp.json` file in your workspace folder. + +```json +{ + "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](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant) from the tools section. +* For more details, refer to the official [Visual Studio documentation](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022). + + +### 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-aspnetcore-assistant": { + "type": "stdio", + "command": "npx", + "args": [ + "-y", + "@syncfusion/aspnetcore-assistant@latest" + ], + "env": { + "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} +``` + +### JetBrains IDEs + +1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP). +2. Click + Add to add a new MCP server configuration. +3. In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config: + +```json +{ + "mcpServers": { + "syncfusion-aspnetcore-assistant": { + "command": "npx", + "args": [ + "-y", + "@syncfusion/aspnetcore-assistant@latest" + ], + "env": { + "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} +``` + +4. Click OK and Apply. + +> For more detailed information about configuring MCP servers in various clients, refer to the official documentations. + * [Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) + * [Cursor](https://cursor.com/docs/context/mcp#using-mcp-json) + * [JetBrains](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server) + * [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json) + +## Usage + +To activate the SyncfusionAspNetCoreAssistant MCP server: + +1. 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. + +2. Grant the SyncfusionAspNetCoreAssistant 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 control (e.g., "How do I create a Syncfusion ASP.NET Core Grid with paging and filtering?"). +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 [SyncfusionAspNetCoreAssistant](https://www.npmjs.com/package/@syncfusion/aspnetcore-assistant): + + * "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](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours \| Unlimited tickets \| Holiday support +* [Community forum](https://www.syncfusion.com/forums/aspnetcore-js2) +* [Request feature or report bug](https://www.syncfusion.com/feedback/aspnet-core) +* Live chat + +## See also + +* [Syncfusion ASP.NET Core Documentation](https://ej2.syncfusion.com/aspnetcore/documentation/getting-started/razor-pages) \ No newline at end of file diff --git a/ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/overview.md b/ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/overview.md new file mode 100644 index 0000000000..e722cf0f88 --- /dev/null +++ b/ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistants/overview.md @@ -0,0 +1,70 @@ +--- +layout: post +title: Syncfusion AI Coding Assistants Overview | Syncfusion +description: Learn how Syncfusion AI Coding Assistants boost ASP.NET Core productivity by generating accurate code snippets, configuration examples, and contextual guidance. +control: Syncfusion AI Coding Assistants Overview +platform: ej2-asp-core-mvc +publishingplatform: ##Platform_Name## +documentation: ug +--- + +# Syncfusion® AI Coding Assistants Overview + +The **Syncfusion® AI Coding Assistants** are designed to streamline your development workflow when building ASP.NET Core applications with Syncfusion® controls. It uses contextual knowledge of the Syncfusion® UI library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. + +AI Coding Assistants: + +* **The SyncfusionAspNetCoreAssistant MCP Server** + Processes advanced prompts and returns tailored code suggestions via [MCP-compatible clients](https://modelcontextprotocol.io/clients). + +## Getting Started + +To use the AI Coding Assistants, 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) +* A [ASP.NET Core application that includes SyncfusionAspNetCore](https://ej2.syncfusion.com/aspnetcore/documentation/getting-started/razor-pages) + +## Unlimited Access + +Syncfusion® offers unlimited access to the AI Coding Assistants, with no limitations 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. + +## Best Practices + +* Initial Setup: Use the tools to quickly add and configure Syncfusion® controls in your ASP.NET Core application. +* 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® ASP.NET Core Documentation](https://ej2.syncfusion.com/aspnetcore/documentation/getting-started/razor-pages) for in-depth information. +* Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, refer to [documentation](https://ej2.syncfusion.com/aspnetcore/documentation/getting-started/razor-pages) or [support](https://support.syncfusion.com/support/tickets/create). + +> Always check AI-generated content and code for accuracy before using it. + +## 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. + +## Privacy & Data Handling + +The Syncfusion® AI Coding Assistants is designed with privacy in mind: + +* The tools do not access your project files or workspace directly. +* User prompts are not stored by any of the tools or used for any other purpose. +* Prompts are not used to train Syncfusion® models. +* The assistant generates context, while the final output is handled by your selected AI model. + +## See also + +* Add the [SyncfusionAspNetCore MCP Server](./mcp-server.md) to an MCP-enabled client +* [Syncfusion® ASP.NET Core Documentation](https://ej2.syncfusion.com/aspnetcore/documentation/getting-started/razor-pages) \ No newline at end of file diff --git a/ej2-asp-core-mvc/EJ2_ASP.NETCORE/introduction.md b/ej2-asp-core-mvc/EJ2_ASP.NETCORE/introduction.md index ede23c88a0..71613044b5 100644 --- a/ej2-asp-core-mvc/EJ2_ASP.NETCORE/introduction.md +++ b/ej2-asp-core-mvc/EJ2_ASP.NETCORE/introduction.md @@ -12,6 +12,8 @@ documentation: ug Essential® JS 2 for ASP.NET Core is a modern enterprise UI toolkit that has been built from the ground up to be lightweight, responsive, modular and touch friendly. It is also available in other frameworks such as JavaScript and Angular, React. +> **Ready to streamline your Syncfusion® ASP.NET Core development?** Discover the full potential of Syncfusion® ASP.NET Core controls with Syncfusion® AI Developer Tools. Effortlessly integrate, configure, and enhance your projects with intelligent, context-aware code suggestions, streamlined setups, and real-time insights—all seamlessly integrated into your preferred AI-powered IDEs like Visual Studio, Visual Studio Code, Cursor, Syncfusion® CodeStudio and more. [Explore Syncfusion® AI Developer Tools](https://ej2.syncfusion.com/aspnetcore/documentation/ai-coding-assistants/overview) + ## How to best read this user guide * The best way to get started would be to read the "Getting Started" section of the documentation for the control that you would like to start using first. The "Getting Started" guide gives just enough information that you need to know before starting to write code. This is the only section that is recommended to read end-to-end before starting to write code, all other information can be referred as needed. diff --git a/ej2-asp-core-toc.html b/ej2-asp-core-toc.html index bd3e9fc710..7f10e3ca32 100644 --- a/ej2-asp-core-toc.html +++ b/ej2-asp-core-toc.html @@ -16,6 +16,12 @@
  • Model Binding in Razor Pages
    • +
  • AI Coding Assistants + +
  • Installation