agent-onboarding
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseSyncfusion onboarding
Syncfusion 接入流程
Use this skill as the front door to Syncfusion. Route the task to the official framework or component
skill. Do not try to reproduce the Syncfusion API from memory here — Syncfusion spans web, desktop,
mobile, document-processing, viewer and editor products, and the same component name has different
packages, imports, registration and licensing rules across them. Cross-framework guessing is the
single largest source of Syncfusion code that does not compile. The second is same-platform name
collision: the word the user typed matches one component while the behavior they asked for belongs
to another — resolve it by comparing inventory descriptions against the required behavior, never by
name alone.
将此skill作为Syncfusion的接入入口。将任务路由至官方框架或组件skill。请勿尝试凭记忆重现Syncfusion API——Syncfusion涵盖Web、桌面、移动、文档处理、查看器及编辑器产品,同一组件名称在不同平台下对应不同的包、导入方式、注册及许可证规则。跨框架猜测是导致Syncfusion代码编译失败的首要原因。其次是同平台名称冲突:用户输入的名称匹配某一组件,但所需功能却属于另一组件——解决此问题需通过对比清单描述与所需功能,绝不能仅依据名称判断。
Hard rule — read the inventory before naming any skill
硬性规则——命名任何skill前必须阅读清单
You MUST have read the platform inventory at
in this session before you name, install, or write code against any Syncfusion component skill.
If you have not read it in this session, fetch it now and do not continue.
https://ai.syncfusion.com/<platform-slug>/inventory.txtWhen the user asks for a component, before you say "I will install skill X" or write any code:
- State the candidate skills you considered (from the inventory, not from memory).
- State the required behavior inferred from the user's request.
- State the evidence — the inventory entry, name, or description that matches.
- Cite the inventory file you read.
If no inventory entry covers the behavior, say so explicitly and ask the human before proceeding.
Never propose a skill name, package name, or import path that is not present in the inventory you
just read. If the only source you have for a name is your training data, label it unverified and
stop until you can cite the inventory or an installed .
SKILL.md在命名、安装或编写任何Syncfusion组件skill相关代码之前,你必须在本次会话中阅读位于的平台清单。若本次会话中尚未阅读,请立即获取该清单,否则不得继续操作。
https://ai.syncfusion.com/<platform-slug>/inventory.txt当用户请求某一组件时,在说出“我将安装skill X”或编写任何代码之前,请执行以下步骤:
- 说明你考虑过的候选skill(来自清单,而非记忆)。
- 说明从用户请求中推断出的所需功能。
- 说明证据——匹配所需功能的清单条目、名称或描述。
- 注明你所阅读的清单文件。
若没有清单条目涵盖所需功能,请明确告知用户并在继续操作前征求其意见。切勿提出未出现在你刚阅读的清单中的skill名称、包名称或导入路径。若名称仅来源于你的训练数据,请标记为未验证并停止操作,直至你能引用清单或已安装的文件。
SKILL.mdRoute first
优先路由
The fastest correct path is almost always:
- Identify the platform from the repository manifest.
- Fetch for that platform. It is self-sufficient: skill pack, packages, license registration, a complete example, and a verification checklist.
https://ai.syncfusion.com/<platform-slug>/llms.txt - Read the platform inventory — — once during setup, not per request. From it, retain a session inventory: a compact routing map of each component skill with its category, its package, and the behaviors its description covers. The session inventory is the routing source for the rest of the session, for as long as session memory lasts.
https://ai.syncfusion.com/<platform-slug>/inventory.txt - List the candidate component skills from the session inventory: every skill whose name, category, or description matches the request. Component names collide inside a platform too, not only across platforms: "a calendar to display events" matches both the Calendars skill (date-selection inputs) and the Scheduler skill (event and appointment management).
- Choose by required behavior, not by the word the user typed, and state the candidates, the choice, and the evidence exactly as the "Hard rule" checklist above requires. If two candidates still tie and the choice changes the implementation, ask one short question and stop.
- Install the skill pack or component skill the comparison selects.
- Read before touching any key.
https://ai.syncfusion.com/licensing.md
Subsequent requests in the same session resolve from the session inventory — do not fetch the
inventory again. This covers both direct requests ("add a Grid") and requests that describe a goal
rather than name a component ("view my PDF file", "edit a document", "display events on a
calendar"). Match the described behavior against the behaviors the map records for each skill; do
not keyword-match the user's words, which wastes context and produces wrong-component answers.
Refetch the inventory, only when the session inventory cannot resolve the request: no candidate
covers the behavior, two candidates tie in a way that changes the implementation, or the request
names a component the map does not contain — it may be newer than the setup read or belong to a
different platform slug.
最快的正确路径几乎总是如下步骤:
- 从仓库清单中识别平台。
- 获取该平台的文件。该文件包含完整信息:skill包、依赖包、许可证注册、完整示例及验证清单。
https://ai.syncfusion.com/<platform-slug>/llms.txt - 在设置阶段阅读一次平台清单——,而非每次请求都读取。从中保留一份session inventory:一份紧凑的路由映射,包含每个组件skill的类别、包及其描述涵盖的功能。session inventory将作为本次会话剩余时间的路由来源,直至会话记忆失效。
https://ai.syncfusion.com/<platform-slug>/inventory.txt - 从session inventory中列出候选组件skill:所有名称、类别或描述与请求匹配的skill。组件名称不仅在跨平台时会冲突,在同一平台内也可能冲突:“用于显示事件的日历”既匹配Calendars skill(日期选择输入组件),也匹配Scheduler skill(事件与预约管理组件)。
- 根据所需功能而非用户输入的词汇进行选择,并严格按照上述“硬性规则”清单的要求说明候选skill、选择结果及证据。若两个候选skill仍难分高下且选择会影响实现方式,请提出一个简短问题后停止操作。
- 安装经对比后选定的skill包或组件skill。
- 在处理任何密钥前阅读。
https://ai.syncfusion.com/licensing.md
本次会话中的后续请求将通过session inventory解决——无需再次获取清单。这既适用于直接请求(如“添加一个Grid”),也适用于描述目标而非指定组件的请求(如“查看我的PDF文件”、“编辑文档”、“在日历上显示事件”)。将描述的功能与映射中记录的每个skill的功能进行匹配;切勿对用户的词汇进行关键词匹配,这会浪费上下文并导致组件选择错误。仅当session inventory无法解决请求时才重新获取清单:无候选skill涵盖所需功能、两个候选skill难分高下且选择会影响实现方式,或请求的组件名称未出现在映射中——该组件可能是在设置后新增的,或属于不同的platform slug。
Sources of knowledge
知识来源
Two sources. Pick the one you are actually reading from, and say so out loud when you make a claim:
- Session inventory — the routing map retained from and the installed skill's
inventory.txt/SKILL.md. Use this for any claim about a component's package, import, or behavior. Cite the file and section.references/*.md - Trained memory — patterns baked into the model. Not citable. Do not use it to fill gaps in the session inventory; the refetch triggers in "Route first" say what to do instead.
Platform Slugs:
reactangularjavascriptvueblazoraspnet-coreaspnet-mvcfluttermauimaui-toolkitwinformswpfwinuidocument-sdkxamarin-to-maui-migrationMaster index: https://ai.syncfusion.com/llms.txt
If you have no network access, the rest of this skill and its references carry enough to proceed.
仅有两个来源。选择你实际正在阅读的来源,并在提出主张时明确说明:
- session inventory——从及已安装skill的
inventory.txt/SKILL.md中保留的路由映射。用于任何关于组件包、导入或功能的主张。需注明文件及章节。references/*.md - 训练记忆——模型内置的模式。无法引用。切勿用其填补session inventory中的空白;“优先路由”部分已说明替代方案。
Platform Slugs:
reactangularjavascriptvueblazoraspnet-coreaspnet-mvcfluttermauimaui-toolkitwinformswpfwinuidocument-sdkxamarin-to-maui-migration若无法访问网络,本skill及其参考资料中的内容足以支持继续操作。
Establish the project context
建立项目上下文
Inspect the repository before asking the user for anything already present. Determine:
- framework, language, runtime, package manager
- existing Syncfusion packages and their exact versions
- the requested component or SDK and the features actually needed
- whether this is a new integration, an edit, an upgrade, a migration, or troubleshooting
- existing theme and CSS setup, application bootstrap, and test and build commands
- existing skills directory and MCP configuration
- evidence of license registration — without printing or exposing any key
Manifest signals: for React, Angular, Vue and JavaScript; for Blazor,
ASP.NET Core, ASP.NET MVC, MAUI, WPF, WinForms and WinUI; for Flutter.
package.json.csprojpubspec.yamlDo not mix examples across platforms. If the repository does not resolve the platform and the choice
changes the implementation, ask one short question and stop.
Two slugs can both be correct: a React application that displays PDFs in the browser and signs them
on a .NET server needs and . Two UI framework slugs never are.
pdf-viewer-sdkdocument-sdk在向用户询问任何已存在的信息前,先检查仓库。确定以下内容:
- 框架、语言、运行时、包管理器
- 已存在的Syncfusion包及其精确版本
- 请求的组件或SDK及实际所需的功能
- 本次操作是新集成、编辑、升级、迁移还是故障排查
- 已有的主题与CSS设置、应用启动流程、测试及构建命令
- 已有的skills目录及MCP配置
- 许可证注册的证据——不得打印或暴露任何密钥
清单信号:React、Angular、Vue及JavaScript项目查看;Blazor、ASP.NET Core、ASP.NET MVC、MAUI、WPF、WinForms及WinUI项目查看;Flutter项目查看。
package.json.csprojpubspec.yaml请勿混合不同平台的示例。若仓库无法确定平台且平台选择会影响实现方式,请提出一个简短问题后停止操作。
可能存在两个正确的slug:在浏览器中显示PDF并在.NET服务器上签名的React应用需要和。但绝不会存在两个正确的UI框架slug。
pdf-viewer-sdkdocument-sdkChoose the path
选择路径
| Need | Path |
|---|---|
| Generate or modify Syncfusion code | A — official agent skills |
| Verify a current API, release change, or advanced configuration | B — current documentation |
| Resolve license setup or a license warning | C — licensing |
| Evaluate Syncfusion before changing the project | D — research only |
A typical implementation uses A, consults B for uncertain details, observes C throughout, and finishes
with verification.
| 需求 | 路径 |
|---|---|
| 生成或修改Syncfusion代码 | A — 官方代理skill |
| 验证当前API、版本变更或高级配置 | B — 最新文档 |
| 解决许可证设置或许可证警告 | C — 许可证管理 |
| 在修改项目前评估Syncfusion | D — 仅调研 |
典型的实现流程会使用路径A,在遇到不确定细节时参考路径B,全程遵循路径C的规则,并以验证收尾。
Path A — official agent skills
路径A — 官方代理skill
Syncfusion publishes component-aware skills containing setup, imports, modules and services,
properties, events, theming, accessibility guidance and implementation patterns — and, more valuable,
the failure modes that public documentation omits.
- Check whether the matching skill is already installed in the agent's skills location.
- If missing and installation is within the user's request, choose the narrowest official pack
or component skill from the retained inventory routing map, using the behavior-based
comparison above. Read for the verified repository names and commands.
references/skill-packs.md - Before running a networked install or changing project-level agent configuration, follow the host's authorization rules.
- Read the selected component completely before implementing. Read only the supporting references the requested features need.
SKILL.md - Follow the installed skill over remembered snippets. Match the versions already in the project unless the user asked for an upgrade.
Prefer a single component skill when the component is known; install a full platform pack when the
user expects broad or repeated Syncfusion work. Project-local installation keeps the skill aligned
with the repository and shareable with the team.
Installing an agent skill does not install the Syncfusion product packages. The component skill
identifies the actual runtime dependencies; install those separately.
Syncfusion发布的组件感知skill包含设置、导入、模块与服务、属性、事件、主题、无障碍指南及实现模式——更重要的是,还包含公开文档未提及的故障模式。
- 检查匹配的skill是否已安装在代理的skills目录中。
- 若缺失且用户请求中包含安装操作,请根据上述基于功能的对比,从保留的清单路由映射中选择范围最窄的官方包或组件skill。阅读获取已验证的仓库名称及命令。
references/skill-packs.md - 在执行联网安装或修改项目级代理配置前,请遵循宿主的授权规则。
- 在实现前完整阅读选定组件的文件。仅阅读所需功能对应的支持性参考资料。
SKILL.md - 遵循已安装skill的指导,而非记忆中的代码片段。除非用户要求升级,否则匹配项目中已有的版本。
若组件已明确,优先选择单个组件skill;若用户需要进行广泛或重复的Syncfusion操作,则安装完整的平台包。项目本地安装可使skill与仓库保持一致,并便于团队共享。
安装代理skill并不会安装Syncfusion产品包。组件skill会识别实际的运行时依赖;需单独安装这些依赖。
Path B — current documentation
路径B — 最新文档
Use when the answer depends on a current API, a recently released feature, an exact package,
migration behaviour, or a troubleshooting detail.
- Use the configured Syncfusion MCP server and its documentation search tool when available.
- Otherwise search the official documentation for the exact framework, component and installed version.
- Use official demos and repositories to supplement documentation — never cross-framework snippets found by general search.
Skills guide code generation; MCP servers retrieve current documentation. They are complementary, and
MCP is optional — it requires an API key, and the anonymous path must work without one. See
.
references/mcp-setup.mdSay when a detail was verified from current documentation. Do not invent an API when authoritative
information is unavailable; state what you could not confirm.
适用于答案依赖当前API、近期发布的功能、精确包、迁移行为或故障排查细节的场景。
- 若可用,使用已配置的Syncfusion MCP服务器及其文档搜索工具。
- 否则,针对精确的框架、组件及已安装版本搜索官方文档。
- 使用官方演示及仓库补充文档——切勿使用通用搜索找到的跨框架代码片段。
skill指导代码生成;MCP服务器检索最新文档。二者互为补充,且MCP是可选的——它需要API密钥,而匿名路径无需密钥即可使用。详见。
references/mcp-setup.md说明细节是否已通过最新文档验证。若权威信息不可用,请勿编造API;说明无法确认的内容。
Path C — licensing
路径C — 许可证管理
Installing and reading Syncfusion agent skills requires no license. Using Syncfusion component
libraries or document SDKs is governed by the applicable commercial, Community, trial or other
product license.
- Never generate, guess, log, echo or commit a license key or MCP API key.
- Do not claim the project is licensed because packages build or skills are installed.
- Reuse the project's existing secret-management pattern. Keep secrets out of source control and out of client-visible output, unless the platform's official registration method explicitly requires application-level registration.
- Use the licensing page for the exact framework and installed version; mechanisms differ by platform and release.
- Never suppress, hide or CSS-hide a licensing banner or warning.
- If a key or account action is required, explain what the human must obtain or authorize, and stop.
- Treat license terms as authoritative. Do not infer production rights from a trial or Community license without verification.
An MCP API key is a credential for the documentation assistant. It is not a product license key.
Full rules:
references/licensing.md安装及阅读Syncfusion代理skill无需许可证。使用Syncfusion组件库或文档SDK需遵循适用的商业版、社区版、试用版或其他产品许可证条款。
- 切勿生成、猜测、记录、回显或提交许可证密钥或MCP API密钥。
- 不得因包可构建或skill已安装就声称项目已获得许可证。
- 复用项目现有的密钥管理模式。将密钥排除在版本控制及客户端可见输出之外,除非平台的官方注册方法明确要求应用级注册。
- 使用对应精确框架及已安装版本的许可证页面;不同平台及版本的机制不同。
- 切勿压制、隐藏或通过CSS隐藏许可证横幅或警告。
- 若需要密钥或账户操作,请说明用户必须获取或授权的内容,然后停止操作。
- 将许可证条款视为权威依据。未经验证,不得从试用版或社区版推断生产使用权限。
MCP API密钥是文档助手的凭据,并非产品许可证密钥。完整规则详见。
references/licensing.mdPath D — research only
路径D — 仅调研
When the user is evaluating Syncfusion, install nothing — no packages, no skills, no MCP
configuration. Identify the target framework and workload, then compare the relevant official
product, documentation, demos, deployment model and licensing requirements. Separate verified facts
from recommendations.
当用户评估Syncfusion时,请勿安装任何内容——无需安装包、skill或MCP配置。确定目标框架及工作负载,然后对比相关的官方产品、文档、演示、部署模式及许可证要求。区分已验证的事实与建议。
Implement
实现
- Preserve the project's framework version, architecture, formatting and dependency conventions.
- Install only the packages the selected component and features require.
- Include every required import, module or service injection, provider, handler, tag-helper registration, theme stylesheet, runtime asset and server dependency the component skill describes.
- Implement the smallest end-to-end slice that demonstrates the requested behaviour, with realistic typed data.
- Emit complete files. No ellipses, no "rest of your code", no partial diff as the primary output.
- Validate loading, empty, error and primary interaction states where relevant.
- Cite the source for every component claim — session inventory or installed . If a line cannot be cited, do not write it.
SKILL.md
- 保留项目的框架版本、架构、格式及依赖约定。
- 仅安装选定组件及功能所需的包。
- 包含组件skill描述的所有必需导入、模块或服务注入、提供者、处理器、标签助手注册、主题样式表、运行时资源及服务器依赖。
- 实现最小的端到端代码片段以演示所需功能,并使用真实的类型化数据。
- 输出完整文件。不得使用省略号、“你的其他代码”或部分差异作为主要输出。
- 在相关场景下验证加载、空状态、错误状态及主要交互状态。
- 为每个组件主张注明来源——session inventory或已安装的。若某一行无法注明来源,则不得编写。
SKILL.md
Verify
验证
Do not report success from compilation alone. Full checklist:
references/verification.mdAt minimum: the component renders or executes, the requested feature is observably exercised, no
licensing warning appears, the runtime log is clean of missing-module and missing-asset errors, and
no key appears in the diff. If runtime verification is unavailable in your environment, say exactly
what remains unverified and give the user a concise manual check.
请勿仅通过编译就报告成功。完整清单详见
references/verification.md至少需满足:组件可渲染或执行、所需功能可正常使用、无许可证警告、运行时日志无缺失模块及缺失资源错误,且差异中无密钥。若你的环境无法进行运行时验证,请明确说明未验证的内容,并为用户提供简洁的手动检查步骤。
Troubleshoot in this order
故障排查顺序
- Framework and Syncfusion package version compatibility
- Missing package, peer dependency, module, service, provider, handler or import
- Theme CSS, fonts, scripts, static assets, or a required server-side endpoint
- Data shape, identifiers, date and number parsing, async lifecycle
- Feature-specific configuration from the installed component skill
- Current official documentation, or an MCP lookup
- A minimal reproduction with unrelated application code removed
Preserve the original error text. Distinguish a product defect from an integration or configuration
issue. Use Syncfusion Support when a minimal reproduction still fails against documented behaviour:
https://support.syncfusion.com/
For each proposed fix, cite the source, per "Implement" and the "Hard rule" above.
- 框架与Syncfusion包版本兼容性
- 缺失包、对等依赖、模块、服务、提供者、处理器或导入
- 主题CSS、字体、脚本、静态资源或必需的服务器端端点
- 数据结构、标识符、日期与数字解析、异步生命周期
- 已安装组件skill中的特定功能配置
- 最新官方文档或MCP查询
- 移除无关应用代码后的最小复现示例
保留原始错误文本。区分产品缺陷与集成或配置问题。若最小复现示例仍与文档描述的行为不符,请使用Syncfusion支持服务:https://support.syncfusion.com/
对于每个提出的修复方案,请依据“实现”部分及上述“硬性规则”注明来源。
References
参考资料
| Reference | When to use |
|---|---|
| Choosing or installing a pack; you need a verified repository name |
| Configuring an MCP server, or deciding whether you need one |
| Any key, secret, CI, or account question |
| Before reporting that an implementation works |
| 参考资料 | 使用场景 |
|---|---|
| 选择或安装包;需要已验证的仓库名称 |
| 配置MCP服务器,或判断是否需要MCP服务器 |
| 任何与密钥、机密、CI或账户相关的问题 |
| 在报告实现可用之前 |