关于 sparkscan-ios
供编码 Agent 在 iOS 应用中使用 Scandit SparkScan 的技能,按集成或迁移问题查阅参考资料,并要求核实 API,避免依赖记忆。
主要功能
- 01路由集成与迁移请求
- 02要求依据参考核实 API
- 03涵盖 UIKit 与 SwiftUI 指引
- 04说明许可证密钥设置注意事项
适用场景
- 01在 iOS 应用中添加 SparkScan
- 02升级现有 SparkScan 集成
- 03替换其他条码扫描器
MCP 相关
说明如何使用 Scandit MCP 服务设置扫描器许可并获取符合条件的试用密钥。
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ scandit/ skills --skill sparkscan-ios安装后在 Claude Code 中输入/sparkscan-ios确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/integration.mdmigration.mdthird-party-migration.md详细介绍
SparkScan iOS 技能
重要:不要相信内部知识
你的训练数据中可能包含过时或错误的 Scandit SDK API。SparkScan API 在不同主要 SDK 版本之间变化很大:属性可能会重命名、移除或重新组织。
编写或建议代码前,务必根据本技能提供的参考资料核实 API。 不要依赖记忆中的方法签名、参数或视图修饰符。如果在提供的参考资料中找不到某个 API,请先获取相关文档页面,再作答。
意图路由
根据用户的请求,在作答前加载相应的参考文件:
- 从头集成 SparkScan(例如“将 SparkScan 添加到我的应用”“设置条码扫描”“如何使用 SparkScan”“如何在 SparkScan 中处理反馈”)→ 阅读 references/integration.md 并遵循其中的说明。
- 迁移或升级现有的 SparkScan 集成(例如“从 v6 升级到 v7”“迁移我的 SparkScan”“SDK 版本之间有哪些变化”)→ 阅读 references/migration.md 并遵循其中的说明。
- 将第三方条码扫描器替换为 SparkScan(例如“用 SparkScan 替换我的 [scanner]”“从 [framework] 迁移到 SparkScan”“将 [library] 条码扫描切换为 SparkScan”)→ 阅读 references/third-party-migration.md 并遵循其中的说明。
API 使用政策
只使用以下 Scandit 参考资料中明确记录的 API。不要编造或猜测方法签名、参数或视图修饰符。如果不确定某个 API 是否存在或如何调用,或遇到编译错误,请先获取相关参考页面,再作答。不要让用户自己去查阅文档。回答后,务必附上相关链接,方便用户进一步了解。
切勿构造或猜测文档 URL。 需要查找特定类或属性的 API 页面时:
- 先检查你已获取的页面(例如 Advanced Configurations 页面)是否包含指向该页面的直接链接——主题页面会直接链接到相关 API 符号。获取内容时,务必同时请求链接。
- 如果没有找到直接链接,请获取 API 索引(参见下表中的 Full API reference),从中提取实际链接并访问该链接。
URL 结构可能有所不同(例如 api/ui/ 子目录),猜测 URL 会导致 404 错误。
许可证密钥
扫描需要 Scandit 许可证密钥。对于此技能,许可证产品为 native,许可证平台为 ios。
按顺序完成以下步骤——绝不要让用户等待 MCP:
-
Scandit MCP 服务已连接 — 使用产品
native、平台ios、app_identifier(应用的 bundle 或 application id;对于 Web,应使用其生产域名,绝不要使用localhost)和env_varSCANDIT_LICENSE_KEY调用ensure_scanner_setup。不要运行它返回的命令。然后使用该结果中的密钥 id,或从list_license_keys获取密钥 id,调用get_license_key;如果list_license_keys显示此密钥不是试用密钥,请先询问用户是否同意再获取。聊天中最多只显示经过掩码处理的预览,绝不要输出完整密钥。 -
未连接 — 只告知用户一次,他们可以在 MCP 客户端中连接远程 Scandit MCP 服务
https://ssl.scandit.com/mcp,然后继续执行步骤 1。不要自行编辑 MCP 客户端配置。身份验证通过浏览器进行,因此不支持无头模式或 CI。该服务只会提供试用密钥;绝不会创建、撤销或修改生产许可证。
-
用户拒绝,或没有 MCP 客户端 — 让他们自行在 https://ssl.scandit.com 生成密钥(尚无账户:https://ssl.scandit.com/dashboard/sign-up?p=test),然后粘贴密钥。
然后将密钥写入代码:将密钥写入许可证密钥调用中,替换占位符——使用 get_license_key 返回的密钥,或用户粘贴或提供的密钥——聊天中仍只显示经过掩码处理的预览。不要在项目、项目文件或环境中搜索密钥。
参考资料
根据用户的问题,为其提供相应资源:
| 主题 | 资源 |
|---|---|
| UIKit 集成 | 入门(UIKit) · 示例 |
| SwiftUI 集成 | 入门(SwiftUI) · 示例 |
| 高级主题(自定义反馈、硬件触发器、扫描模式、UI 自定义) | 高级配置 |
| 完整 API 参考 | SparkScan API |