← All agents / Claude Code
ANTHROPIC
Claude Code + Syncfusion
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 one prompt. Claude Code handles the setup from there.
Paste the setup prompt
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
- Fetches the official setup instructions.
- Installs the Syncfusion onboarding skill.
- Detects the project platform from its manifest.
- Finds and installs the appropriate Syncfusion skills.
- Reads the applicable licensing guidance.
- Checks whether MCP is configured and reports any action you need to take.
What this gives Claude Code
Agent skills — 775 across 18 platform and SDK packs
Component-aware instructions covering setup, imports, modules and services, properties, events, theming, accessibility and the failure modes documentation omits. Free, public Markdown — no license, key or account.
Read from .claude/skills/ in the project, ~/.claude/skills/ globally.
MCP servers — 14, one per platform
npm @syncfusion/<platform>-mcp for the JavaScript-family platforms, NuGet
Syncfusion.<Platform>.MCP for the .NET platforms. All stdio. All read the
same two environment variables.
Do not use @syncfusion/*-assistant packages — that npm family is
deprecated, and a higher version number on one does not mean it supersedes the
-mcp or .MCP package.
Server table and prerequisites · Configuration for Claude Code
Syncfusion CLI — scaffolding and the component templates
sf new scaffolds a project; sf add <component> adds ready-to-use
component templates, including Grid, Chart, Scheduler, Gantt, File Manager, Diagram, Rich Text
Editor, PDF Viewer, DOCX Editor, and Spreadsheet Editor, resolving dependencies and writing the
file.
Agent-readable documentation
Every human page here has a machine twin at a deterministic URL, and every platform index is self-sufficient in a single fetch.
/llms.txt — routing · /llms-full.txt — everything inlined · /agent-setup/prompt.md — the setup instructions themselves
Advanced manual setup
The quick-start prompt is sufficient for normal setup. Use this section only when you want to add optional live documentation retrieval yourself.
Configure MCP — optional
MCP gives Claude Code live documentation retrieval. It requires an API key from your Syncfusion account. This is not a product license key, and MCP is not required to use the installed skills.
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.
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 configuration guide.
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
Once Claude Code is set up, these should work without you naming a platform, a package or a property.
Tips
- Skills live in
.claude/skills/per project. Commit them so the whole team gets the same behaviour. - Use
/contextto check the skill was actually loaded rather than assuming it was.
Verify it worked
In a fresh session, ask Claude Code to add a Syncfusion component. Three signals.
| 1 | It identifies your platform from the manifest before writing code, rather than guessing from your phrasing. |
| 2 | It reads the installed skill rather than producing a remembered snippet — it will usually say which skill it used. |
| 3 | It mentions license registration and does not emit a key. |
If it 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.
Troubleshooting
| Symptom | First thing to check |
|---|---|
| The agent ignores the skill | Confirm the skill is in .claude/skills/,
then restart the session. Most agents load skills at session start. |
| MCP server not listed | Configuration file path and syntax. Most clients read MCP config only at startup — restart Claude Code. |
| Server listed, no tools | The process failed to start. Run its command manually in a terminal and read the real error. |
| Server starts, every query fails | The API key. Casing is
Syncfusion_API_Key_Path, and the path must resolve. |
npx cannot find the package | Node.js 18 or later, and network access
to the npm registry. Also confirm you are not using a deprecated
-assistant package. |
dnx not found | .NET 10 SDK. On .NET 8 or 9 use the documented
fallback, dotnet tool run syncfusion-<platform>-mcp. |
| Generated code mixes two frameworks | The agent skipped platform detection. Point it at the platform index for your slug and tell it not to blend platforms. |
| A licensing banner appears at runtime | Registration order, or a key that predates a package upgrade. Never suppress the banner. See /licensing.md. |
Frequently asked
- Do I need a Syncfusion license to install the skills?
- No. Installing and reading Syncfusion agent skills requires no license, no key and no account. Using Syncfusion component libraries or document SDKs in an application does require a commercial, Community or trial license.
- Is MCP required?
- No. MCP retrieves current documentation and needs an API key. The anonymous path — the onboarding skill, the platform index and the public documentation — is complete without it. If no key is available, skip MCP rather than blocking on it.
- Does installing a skill install the Syncfusion packages?
- No. The skill is Markdown instructions. It tells your agent which npm or NuGet packages the component actually needs; those are installed separately.
- Should I install a whole platform pack or one skill?
- One skill, when you know the component — retrieval noise costs more than the marginal skill is worth. Install the whole pack when you expect broad or repeated Syncfusion work.
- Is the MCP API key the same as my license key?
- No. They are different credentials for different things, and neither grants the other. An MCP API key authenticates the documentation assistant; a license key covers your use of the libraries.
Ownership boundary. A Syncfusion component is a licensed package installed from npm or NuGet — not source you vendor and own. What you own and edit freely is the composition around it: the wrapper, the configuration object, the data adapter, the theme tokens, the layout, the event handlers. Full trust boundary →