@syncfusion/react-assistant
v2.0.0
Published
Syncfusion React MCP Server
Downloads
796
Readme
Syncfusion React MCP Server
Overview
Transform your development experience with intelligent AI assistance powered by the Syncfusion React MCP Server. Built on the Model Context Protocol, this tool bridges your development environment with Syncfusion's comprehensive React component ecosystem, delivering contextual intelligence directly into your AI-powered workflow.
The server operates in two specialized modes:
- Agentic UI Builder (
#sf_react_ui_builder) - Build complete UIs with coordinated tools for layouts, components, and styling. Ideal for creating pages, dashboards, and complex sections from scratch. - AI Coding Assistant (
#sf_react_assistant) - Implement individual components with focused API guidance. Perfect for adding components to existing projects and troubleshooting integration issues.
Key Features
- Expert Component Knowledge - Deep understanding of Syncfusion React components and their implementation patterns.
- Complete Design System - Guidance for Tailwind3 CSS, Bootstrap 5.3, Material 3, and Fluent 2 design systems with utility-based styling examples and 600+ accessible icons.
- Pre-Built Layouts - Ready-to-use UI blocks for rapid application development.
- Unlimited Usage - No request limits, time restrictions, or query caps.
- Privacy-Focused - Your data remains secure. The tools do not access files, store data, or use your prompts for training purposes.
Prerequisites
Before using the Syncfusion React MCP Server, ensure you have:
- Node.js version 18 or higher
- A compatible MCP client (VS Code, Syncfusion® CodeStudio, etc.)
- An active Syncfusion® API key
- A React application (existing or new—see Quick Start)
- An active Syncfusion® license (any of the following):
Unlimited Access
Syncfusion® offers unlimited access to the React MCP server with no restrictions on:
- Number of requests and application generations
- Component usage across all Syncfusion® React libraries
- Query complexity and length
- Usage duration and session time
This ensures you can fully leverage AI-powered development without limitations.
Installation and Setup
Configure your MCP client with the following core settings. The Generic MCP Server Settings shown below are identical across all supported clients:
Generic MCP Server Settings
- npm package name:
@syncfusion/react-assistant - Type: stdio (standard input/output transport)
- Command: npx
- Arguments: -y
- Server name: sf-react-mcp
API Key Configuration
Log in to your Syncfusion account and generate an API key from the API Key page. You have two secure options for providing your API key:
Option 1: Using an API Key File (Recommended)
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 it doesn't expose the key directly in configuration files.
Supported file formats: .txt or .key file
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
}Option 2: Direct API Key
Provide your API key directly in the configuration:
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}Below are setup instructions for popular MCP clients:
Syncfusion® Code Studio
- In Code Studio, open the MCP Marketplace, find
Syncfusion React Assistant, and click Install. - When prompted, provide your Syncfusion API key to register the MCP.
- The server installs locally and is available in the Installed list—it is then ready to use. See the Code Studio documentation for details.
VS Code
- To configure an MCP server for a specific workspace, create a
.vscode/mcp.jsonfile in your workspace folder.
{
"servers": {
"sf-react-mcp": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@syncfusion/react-assistant@latest"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}- After updating
mcp.json, you'll notice a "Start" option at the top of the config to launch the server. Check for a confirmation message likeSyncfusion React MCP server is running...in the output. - For additional guidance, refer to the VS Code documentation.
Cursor
To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder.
{
"mcpServers": {
"sf-react-mcp": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@syncfusion/react-assistant@latest"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}For more details, refer to the Cursor documentation.
JetBrains IDEs
- Navigate to Settings → Tools → AI Assistant → Model Context Protocol (MCP)
- Click + Add to create a new MCP server configuration
- In the New MCP Server dialog, switch to
As JSONand add:
{
"mcpServers": {
"sf-react-mcp": {
"command": "npx.cmd",
"args": ["-y", "@syncfusion/react-assistant@latest"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}- Click OK and Apply
See JetBrains documentation for further assistance.
Note: For other MCP clients like Windsurf, refer to their official documentation for MCP server configuration. The core configuration remains the same across all clients.
Usage
The Syncfusion React MCP Server operates in two distinct modes, each optimized for different development scenarios.
Agentic UI Builder
Use the Agentic UI Builder when you need to generate complete projects, pages, or complex features. This mode orchestrates multiple specialized tools to deliver comprehensive solutions.
When to use:
- Creating new applications or major features
- Building multi-component pages
- Scaffolding application structures
How to use:
Activate the Agentic UI Builder in your IDE by using the #sf_react_ui_builder handle followed by your requirements:
#sf_react_ui_builder Create a login page with tailwind3 theme using a centered card layout containing email and password input fields with validation. Include a "Remember Me" checkbox, forgot password link, and primary login button.Individual tools
For targeted assistance, you can call individual tools directly using their specific tool names. This is useful when you need specialized help from a particular tool.
| Tool | Purpose | Example |
|------|---------|---------|
| #sf_react_layout | Pre-built UI patterns and layouts (up to 3 snippets) | #sf_react_layout Design a responsive pricing card page with feature comparison |
| #sf_react_component | Component APIs, props, methods, and configuration | #sf_react_component Configure DataGrid with sorting and filtering |
| #sf_react_style | Theme configuration, visual customization, and icon integration | #sf_react_style How do I apply the Syncfusion Tailwind 3 dark theme and add a communication icon inside a button? |
AI Coding Assistant
Use the AI Coding Assistant when you need help with implementing or customizing Syncfusion React components. This mode provides intelligent, context-aware assistance for working with individual components.
When to use:
- Configuring component properties and methods
- Understanding component APIs and events
- Implementing specific component features
- Troubleshooting component issues
How to use:
Activate the AI Coding Assistant in your IDE by using the #sf_react_assistant handle followed by your query:
#sf_react_assistant How do I enable paging and sorting in the Syncfusion React Grid?Best Practices
For optimal results, use high-performance AI models like Claude Sonnet 4.5 (recommended), GPT-5, or Gemini 3 Pro. These models better understand complex component relationships and generate more accurate React code.
Always review AI-generated code before using in production.
Privacy & Security
The Syncfusion React MCP Server is designed with privacy considerations:
- The server does not access project files or workspace contents directly.
- User prompts are not stored or used for other purposes.
- Prompts are not used to train Syncfusion models.
- The assistant provides context; the final output is produced by the selected AI model.
The MCP server acts purely as a knowledge bridge, connecting your AI model with Syncfusion-specific expertise while respecting your privacy and maintaining security.
Support
Product support is available through the following media:
- Support ticket - Guaranteed response within 24 hours | Unlimited tickets | Holiday support
- Community forum
- Request feature or report bug
- Live chat
License
This is a commercial product and requires a paid license for possession or use. Syncfusion® licensed software, including this component, is subject to the terms and conditions of Syncfusion's EULA. To acquire a license, you can purchase here or start a free 30-day trial here.
A free community license is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.
© Copyright 2026 Syncfusion® Inc. All Rights Reserved. The Syncfusion® Essential Studio® license and copyright applies to this distribution.
