# Set up Cursor for Syncfusion

Source: https://ai.syncfusion.com/agent-setup/cursor.md  
Canonical: https://ai.syncfusion.com/agent-setup/cursor.md  
Entry-point: https://ai.syncfusion.com/llms.txt  
Updated: 2026-08-28  
Agent: Cursor  
Skills project directory: `.agents/skills/`  
Skills global directory: `~/.cursor/skills/`  
MCP configuration: optional; `.cursor/mcp.json`  
License posture: Everything here is free to read. Installing Syncfusion agent skills requires no license, key, or account. Using Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md.

Use Cursor with Syncfusion through one setup prompt, platform-aware guidance, and optional live documentation retrieval.

## Quick start

Open Cursor in your project and send this prompt:

```text
Set up this project for Syncfusion before generating code. Fetch and follow the official instructions at https://ai.syncfusion.com/agent-setup/prompt.md, then report the detected platform, installed skill pack, MCP status, and any required licensing action.
```

This is the only setup instruction you need to provide. Cursor may ask you to approve commands before running them.

No license, API key, or account is needed to read the setup instructions or install supported skills. Using Syncfusion libraries in an application requires a commercial, Community, or trial license.

## What Cursor does

1. Fetches the official setup instructions.
2. Installs the Syncfusion onboarding skill.
3. Detects the project platform from its manifest.
4. Finds and installs the appropriate Syncfusion skills.
5. Reads the applicable licensing guidance.
6. Checks whether MCP is configured and reports any action you need to take.

## What the setup provides

### Onboarding skill

Routes future Syncfusion requests to the correct platform and component instructions.

### Platform and component skills

Provide framework-specific guidance for packages, imports, modules, services, themes, accessibility, configuration, and common failure modes.

Skills are read from `.agents/skills/` in the project or `~/.cursor/skills/` globally.

- Skill catalog: https://ai.syncfusion.com/skills/catalog.md
- Onboarding skill: https://ai.syncfusion.com/agent-onboarding/SKILL.md

### Agent-readable documentation

- Routing: https://ai.syncfusion.com/llms.txt
- Full documentation: https://ai.syncfusion.com/llms-full.txt
- Setup instructions: https://ai.syncfusion.com/agent-setup/prompt.md

## Advanced manual setup

The quick-start prompt is sufficient for normal setup. Use this section only when you want to configure optional live documentation retrieval yourself.

### Configure MCP — optional

MCP gives Cursor live Syncfusion documentation retrieval. It requires an API key from https://www.syncfusion.com/account/api-key. This is not a product license key, and MCP is not required to use the public documentation or installed skills.

MCP location: `.cursor/mcp.json`

Follow the exact Cursor configuration guide: https://ai.syncfusion.com/mcp/cursor.md

Use `Syncfusion_API_Key_Path` exactly as written. Never put the API key value in a file that could be committed.

## Example prompts

- Add a Syncfusion data grid to this page with sorting, paging, and Excel export.
- This Syncfusion grid renders, but paging does nothing. Find the cause and fix it.
- Convert the Word documents in `./contracts` to PDF on the server using Syncfusion.
- Register my Syncfusion license key from an environment variable. Do not put it in source.
- Upgrade this project's Syncfusion packages to the current release and fix what breaks.

## Verify it worked

In a fresh session, ask Cursor to add a Syncfusion component. Confirm that it:

1. Identifies the platform from the project manifest before writing code.
2. Reads the installed skill instead of producing a remembered snippet.
3. Mentions license registration without emitting a key.

If Cursor writes Syncfusion code from memory, the onboarding setup did not complete or the installed skill was not loaded. Restart Cursor and run the setup prompt again.

## Frequently asked

### Do I need a Syncfusion license to use the setup instructions?

No. Reading the instructions and installing supported skills requires no license, key, or account. Using Syncfusion component libraries or document SDKs in an application requires a commercial, Community, or trial license.

### Is MCP required?

No. MCP retrieves current documentation and requires an API key. Public routing and platform documentation work without it.

### Does installing a skill install Syncfusion packages?

No. A skill contains instructions. The required npm or NuGet packages are installed separately when a component is implemented.

### Is the MCP API key the same as my license key?

No. The MCP API key authenticates documentation retrieval. A product license key covers your use of Syncfusion libraries.

## Other tools

- Claude Code: https://ai.syncfusion.com/agent-setup/claude-code.md
- Cline: https://ai.syncfusion.com/agent-setup/cline.md
- Code Studio: https://ai.syncfusion.com/agent-setup/code-studio.md
- Codex: https://ai.syncfusion.com/agent-setup/codex.md
- Gemini CLI: https://ai.syncfusion.com/agent-setup/gemini-cli.md
- JetBrains IDEs: https://ai.syncfusion.com/agent-setup/jetbrains.md
- VS Code: https://ai.syncfusion.com/agent-setup/vs-code.md
- Windsurf: https://ai.syncfusion.com/agent-setup/windsurf.md
