Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions ej2-react-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@
</ul>
</li>
<li>
AI Developer Tools
<ul>
<li><a href="/ej2-react/ai-developer-tools/overview">Overview</a></li>
<li><a href="/ej2-react/ai-developer-tools/mcp-server">MCP Server</a></li>
<li><a href="/ej2-react/ai-developer-tools/copilot-extension">Copilot Extension</a></li>
</ul>
</li>
<li>
Installation
<ul>
<li><a href="/ej2-react/installation/installation">Installation with npm cli</a></li>
Expand Down
101 changes: 101 additions & 0 deletions ej2-react/ai-developer-tools/copilot-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
layout: post
title: SyncfusionReact GitHub Copilot Extension | Syncfusion
description: Learn how the SyncfusionReact GitHub Copilot extension enhances your React development with intelligent code suggestions, best practices, contextual guidance.
control: Getting started with SyncfusionReact copilot extension
platform: ej2-react
documentation: ug
domainurl: ##DomainURL##
---

# SyncfusionReact GitHub Copilot Extension

## Overview

The [SyncfusionReact GitHub Copilot Extension](https://github.com/apps/syncfusionreact) provides intelligent assistance for developers using Syncfusion's React component libraries. This extension seamlessly integrates with GitHub Copilot to enhance your development workflow.

### What is a GitHub Copilot Extension?

A GitHub Copilot extension enhances Copilot's capabilities by integrating specialized, third-party tools and knowledge directly into the chat interface. It allows Copilot to access specific data, APIs, and services—such as a component vendor's official documentation—to provide more accurate, context-aware, and relevant assistance for a developer's specific technology stack.

### Key Benefits

* Smart code suggestions for Syncfusion<sup style="font-size:70%">&reg;</sup> React components.
* Best practice guidance for component usage and configuration.
* Context-aware troubleshooting for complex scenarios.

## Prerequisites

Before using this extension, ensure you have:

* [Github copilot](https://github.com/copilot/)
* An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Free Community License](https://www.syncfusion.com/products/communitylicense)
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)
* An active [API KEY](https://staging.syncfusion.com/account/user-token-generation)

## Unlimited Access

Syncfusion<sup style="font-size:70%">&reg;</sup> users enjoy completely unlimited access to this copilot extension. There are no restrictions on:

* No request limits
* No component restrictions
* No query type limitations
* No usage duration constraints

We believe in providing unrestricted access to tools that enhance your development experience, ensuring you can fully leverage Syncfusion<sup style="font-size:70%">&reg;</sup> components without limitations.

## Installation

* Visit the [SyncfusionReact GitHub App](https://github.com/apps/syncfusionreact) and click **Install**.
* Grant the required read-access permissions to allow the extension to function with Copilot chat.
* Click **Install & Authorize**.
* Sign in with your Syncfusion<sup style="font-size:70%">&reg;</sup> account credentials to complete the authorization.

Based on the authorization, we will fetch the API key from your account and utilize it for response generation. After successful authentication, the extension will be integrated with your GitHub account.

Restart your apps and begin a new Copilot chat session to start using it.

## Getting Started

* Open the chat panel in a supported environment like [GitHub Copilot](https://github.com/copilot) or VSCode Copilot.
* In the chat prompt, type `@` and select the `SyncfusionReact` extension from the list.
* Enter your query related to any Syncfusion<sup style="font-size:70%">&reg;</sup> React component.

**Note:** When using this extension in VS Code, make sure you are in Ask mode and not in Edit or Agent mode. The Edit and Agent modes do not use the Syncfusion<sup style="font-size:70%">&reg;</sup> Copilot extension.

### Best Practices for Effective Usage

1. `Be specific`: Mention both platform and component (e.g., "How do I create a Syncfusion React 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 examples of queries you can use with the Syncfusion<sup style="font-size:70%">&reg;</sup> Copilot extensions:

* "@SyncfusionReact Create a Syncfusion data grid with paging and sorting"
* "@SyncfusionReact How do I implement a responsive Syncfusion chart with tooltips?"
* "@SyncfusionReact Show me a Syncfusion Kanban board implementation with drag and drop"

## Uninstallation

To remove the extension from your account:

* Go to [GitHub App Installations](https://github.com/settings/installations/).
* Locate the `SyncfusionReact` extension in the list.
* Click `Configure` and Select `Uninstall`.

## Support

* [Support tickets](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
* [Community forum](https://www.syncfusion.com/forums/essential-js2)
* [Request feature or report bug](https://www.syncfusion.com/feedback/javascript)
* Live chat

## See also

* [Syncfusion<sup style="font-size:70%">&reg;</sup> React Documentation](https://ej2.syncfusion.com/react/documentation)
* [Github Copilot Documentation](https://docs.github.com/en/copilot)
205 changes: 205 additions & 0 deletions ej2-react/ai-developer-tools/mcp-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
---
layout: post
title: SyncfusionReactAssistant MCP Server | Syncfusion
description: Learn how to configure and use SyncfusionReactAssistant MCP server for intelligent code generation, documentation, and troubleshooting in React apps.
control: Getting started with SyncfusionReactAssistant MCP Server
platform: ej2-react
documentation: ug
domainurl: ##DomainURL##
---

# SyncfusionReactAssistant MCP Server

## Overview

The [SyncfusionReactAssistant](https://www.npmjs.com/package/@syncfusion/react-assistant) is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides intelligent assistance for developers using Syncfusion's React component libraries. This tool seamlessly integrates with compatible MCP clients to enhance your development workflow when building React applications with Syncfusion<sup style="font-size:70%">&reg;</sup> components.

### Key Benefits

* Intelligent code generation for Syncfusion<sup style="font-size:70%">&reg;</sup> React components.
* Detailed component documentation and usage examples.
* Troubleshooting assistance for common integration challenges.

## Prerequisites

Before using [SyncfusionReactAssistant](https://www.npmjs.com/package/@syncfusion/react-assistant), ensure you have:

* Required [node](https://nodejs.org/en/) version >= 18
* A [compatible MCP client](https://modelcontextprotocol.io/clients) (Syncfusion<sup style="font-size:70%">&reg;</sup> CodeStudio, VS Code with GitHub Copilot, etc.)
* An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Free Community License](https://www.syncfusion.com/products/communitylicense)
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)
* An active [API KEY](https://staging.syncfusion.com/account/user-token-generation)

## Unlimited Access

Syncfusion<sup style="font-size:70%">&reg;</sup> users enjoy completely unlimited access to this MCP server. There are no restrictions on:

* No request limits
* No component restrictions
* No query type limitations
* No usage duration constraints

We believe in providing unrestricted access to tools that enhance your development experience, ensuring you can fully leverage Syncfusion components without limitations.

## Installation and setup

Before you can invoke the SyncfusionReactAssistant 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/react-assistant`
- **Type**: stdio (standard input/output transport)
- **Command**: npx
- **Arguments**: -y
- **Server name**: syncfusionReactAssistant

You need to add your [Syncfusion API key](https://staging.syncfusion.com/account/user-token-generation) as an env parameter in the configuration file:

```json
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}
```

[SyncfusionReactAssistant](https://www.npmjs.com/package/@syncfusion/react-assistant) can be configured in various MCP clients. Below are setup instructions for popular environment:

### Syncfusion<sup style="font-size:70%">&reg;</sup> Code Studio

* Install directly from the [Syncfusion Code Studio](https://www.syncfusion.com/code-studio/) MCP Marketplace.
* Start the server and grant permission when prompted.

### VS 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-react-assistant": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@syncfusion/react-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 [SyncfusionReactAssistant](https://www.npmjs.com/package/@syncfusion/react-assistant) server directly from the settings interface without additional commands.

3. Confirm that [SyncfusionReactAssistant](https://www.npmjs.com/package/@syncfusion/react-assistant) is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
* `SyncfusionReactAssistant is running...` (in VS Code)

### 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-react-assistant": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@syncfusion/react-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-react-assistant": {
"command": "npx",
"args": [
"-y",
"@syncfusion/react-assistant@latest"
],
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}
```

Click OK and Apply.

> For more detailed information about configuring MCP servers in various clients, refer to the official documentations.
* [VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server)
* [Cursor](https://docs.cursor.com/en/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 SyncfusionReactAssistant MCP server:

1. Start your prompt with one of the following:
* 'SyncfusionReactAssistant'
* '/syncfusion-react-assistant'
* '/syncfusion-react'
* '@syncfusion-react'
* '@ask_syncfusion_react'
* 'ej2-react'

In VS Code, you can also use #SyncfusionReactAssistant to explicitly invoke the MCP server.

2. Grant the SyncfusionReactAssistant 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.

### Best Practices for Effective Usage

1. `Be specific`: Mention both platform and component (e.g., "How do I create a Syncfusion React 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 [SyncfusionReactAssistant](https://www.npmjs.com/package/@syncfusion/react-assistant):

* "Create a Syncfusion React Grid component with paging, sorting and filtering"
* "How do I implement data binding with Syncfusion React scheduler?"
* "Show me how to create a dashboard with multiple Syncfusion components"

## 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/essential-js2)
* [Request feature or report bug](https://www.syncfusion.com/feedback/javascript)
* Live chat

## See also

* [Syncfusion React Documentation](https://ej2.syncfusion.com/react/documentation)
67 changes: 67 additions & 0 deletions ej2-react/ai-developer-tools/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
layout: post
title: Syncfusion AI Developer Tools Overview | Syncfusion
description: Learn how Syncfusion AI Developer Tools boost React productivity by generating accurate code snippets, configuration examples, and contextual guidance.
control: Syncfusion AI Developer Tools Overview
platform: ej2-react
documentation: ug
domainurl: ##DomainURL##
---

# Syncfusion<sup style="font-size:70%">&reg;</sup> AI Developer Tools Overview

The **Syncfusion<sup style="font-size:70%">&reg;</sup> AI Developer Tools** is designed to streamline your development workflow when building React applications with Syncfusion<sup style="font-size:70%">&reg;</sup> controls. It uses contextual knowledge of the Syncfusion<sup style="font-size:70%">&reg;</sup> component library to generate accurate code snippets, configuration examples, and guided explanations—so you spend less time searching docs and more time coding.

SyncfusionReact AI Developer Tools are:

* The SyncfusionReact MCP Server — Handles advanced prompts and delivers tailored code suggestions for MCP-compatible clients.
* The SyncfusionReact GitHub Copilot Extension — Enhances Copilot with Syncfusion-specific support for quick component setup and guidance in your IDE.

## Getting Started

To use the SyncfusionReact AI Developer Tools, you need:

* A [Syncfusion<sup style="font-size:70%">&reg;</sup> user account](https://www.syncfusion.com/account)
* An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Free Community License](https://www.syncfusion.com/products/communitylicense)
- [Syncfusion<sup style="font-size:70%">&reg;</sup> Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)
* An active [API KEY](https://staging.syncfusion.com/account/user-token-generation)
* A [React application that includes SyncfusionReact](https://ej2.syncfusion.com/react/documentation/getting-started/quick-start)

## Unlimited Access

Syncfusion<sup style="font-size:70%">&reg;</sup> users enjoy completely unlimited access to Syncfusion<sup style="font-size:70%">&reg;</sup> AI Developer Tools. There are no restrictions on:

* No request limits
* No component restrictions
* No query type limitations
* No usage duration constraints

We believe in providing unrestricted access to tools that enhance your development experience, ensuring you can fully leverage Syncfusion components without limitations.

## Best Practices

* Initial Setup: Use the assistant to quickly add and configure components.
* Feature Tuning: Enable or disable component features through prompt-based configuration.
* Data Binding: Generate sample data for testing and prototyping. Avoid using sensitive or production data.
* Step-by-step explanations: Use annotated code to understand component behavior (depends on the tool, mode, and model used). To further develop your knowledge, check the respective documentation.
* Component-based styling: Utilize component-specific styles to override theme styles with custom selectors. For further customization, explore [Theme Studio](https://ej2.syncfusion.com/themestudio/?theme=bootstrap5.3) or [Figma UI kits](https://www.figma.com/@syncfusion).
* Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, refer to documentation or support.
* Session Management: Start fresh sessions when switching tasks to maintain prompt relevance.
* Model Compatibility: For best results, use with models like GPT-5 or Claude Sonnet 4.

## Privacy & Data Handling

The Syncfusion<sup style="font-size:70%">&reg;</sup> AI Developer Tools is designed with privacy in mind:

* It does not access your project files or workspace directly.
* We don’t store your prompts in any of the tools or for any other purpose.
* Prompts are not used to train Syncfusion<sup style="font-size:70%">&reg;</sup> models.
* The assistant generates context, not final responses—your selected AI model handles the output.

## See also

* Add the [SyncfusionReact MCP Server](./mcp-server.md) to an MCP-enabled client
* Install the [SyncfusionReact GitHub Copilot Extension](./copilot-extension.md)
* [Syncfusion<sup style="font-size:70%">&reg;</sup> React Documentation](https://ej2.syncfusion.com/react/documentation)