# Set up Claude Code for Syncfusion

Source: https://ai.syncfusion.com/agent-setup/claude-code.md  
Canonical: https://ai.syncfusion.com/agent-setup/claude-code.md  
Entry-point: https://ai.syncfusion.com/llms.txt  
Agent: Claude Code  
Skills project directory: `.claude/skills/`  
Skills global directory: `~/.claude/skills/`  
MCP configuration: optional  
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.

Claude Code is a terminal-based coding agent that reads your codebase, runs commands, edits files, and works with Git.

## Quick start

Open Claude Code in your project directory 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. Claude Code may ask you to approve commands before it runs them.

No license, API key, or account is needed to install the skills. Using Syncfusion libraries in an application requires a commercial, Community, or trial license.

## What Claude Code does

Claude Code:

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.
7. Reports what it installed and 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 `.claude/skills/` in the project or `~/.claude/skills/` globally.

- Skill catalog: https://ai.syncfusion.com/skills/catalog.md
- Onboarding skill: https://ai.syncfusion.com/agent-onboarding/SKILL.md

### Agent-readable documentation

Machine-readable routing, platform guidance, and setup instructions are available at deterministic URLs:

- 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 Claude Code 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 installed skills.

Store the key in a file outside the repository:

```bash
mkdir -p ~/.syncfusion
printf '%s' 'PASTE_YOUR_API_KEY_HERE' > ~/.syncfusion/api-key.txt
chmod 600 ~/.syncfusion/api-key.txt
```

Add the MCP server from the command line. This React example uses the JavaScript-family package; use the package for your detected platform:

```bash
claude mcp add sf-react-mcp \
  --env Syncfusion_API_Key_Path=/absolute/path/to/syncfusion-api-key.txt \
  -- npx -y @syncfusion/react-mcp@latest
```

Run `claude mcp list` to confirm the server is available. For another platform or .NET, use the Claude Code MCP guide: https://ai.syncfusion.com/mcp/claude-code.md.

Variable casing is exact: use `Syncfusion_API_Key_Path`, not `SYNCFUSION_API_KEY`. Never put the key value in a file that could be committed.

## Example prompts

After setup, you can give Claude Code normal development requests without naming a package or platform:

- 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 Claude Code 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 Claude Code writes Syncfusion code from memory, the onboarding setup did not complete or the installed skill was not loaded. Restart Claude Code and run the setup prompt again.

## Frequently asked

### Do I need a Syncfusion license to install the skills?

No. Installing and reading Syncfusion agent 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 needs an API key. The onboarding skill, platform index, and public documentation work without it.

### Does installing a skill install Syncfusion packages?

No. A skill contains instructions. Claude Code installs the required npm or NuGet packages separately when it implements a component.

### 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

- Codex: https://ai.syncfusion.com/agent-setup/codex.md
- Gemini CLI: https://ai.syncfusion.com/agent-setup/gemini-cli.md
- Cursor: https://ai.syncfusion.com/agent-setup/cursor.md
- Windsurf: https://ai.syncfusion.com/agent-setup/windsurf.md
- VS Code: https://ai.syncfusion.com/agent-setup/vs-code.md
- Code Studio: https://ai.syncfusion.com/agent-setup/code-studio.md
- JetBrains IDEs: https://ai.syncfusion.com/agent-setup/jetbrains.md
- Cline: https://ai.syncfusion.com/agent-setup/cline.md
