sparkscan-ios について
iOS アプリで Scandit SparkScan を扱うコーディングエージェント向けスキルです。統合や移行の質問に応じて資料を参照し、API を記憶に頼らず確認するよう定めています。
主な機能
- 01統合・移行リクエストの振り分け
- 02資料に基づく API 確認
- 03UIKit と SwiftUI の案内
- 04ライセンスキー設定時の注意
活用シーン
- 01iOS アプリへの 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 に置き換える場合(例:「[scanner] を SparkScan に置き換える」「[framework] から SparkScan に移行する」「[library] のバーコードスキャンを切り替える」)→ references/third-party-migration.md を読み、そこに記載された手順に従ってください。
API の使用ポリシー
以下の Scandit リファレンスに明記されている API のみを使用してください。メソッドシグネチャ、パラメーター、ビュー修飾子を創作したり、推測したりしないでください。API が存在するか、どのように呼び出すか不明な場合、またはコンパイルエラーが発生した場合は、回答する前に該当するリファレンスページを取得してください。ユーザーに自分でドキュメントを確認するよう伝えないでください。回答後は、ユーザーがさらに調べられるよう、必ず関連リンクを含めてください。
ドキュメントの URL を組み立てたり、推測したりしないでください。 特定のクラスやプロパティの API ページが必要な場合は、次の手順に従ってください。
- まず、取得済みのページ(例:Advanced Configurations ページ)に、そのページへの直接リンクが含まれているか確認してください。トピックページには、関連する API シンボルへの直接リンクがあります。取得を依頼する際は、必ず本文とともにリンクも求めてください。
- 直接リンクが見つからない場合は、API インデックス(下の表にある Full API reference を参照)を取得し、そこから実際のリンクを抽出して、そのリンク先をたどってください。
URL の構成は異なる場合があります(例:api/ui/ サブディレクトリ)。推測すると 404 エラーにつながります。
ライセンスキー
スキャンには Scandit のライセンスキーが必要です。このスキルでは、ライセンス製品は native、ライセンスプラットフォームは ios です。
以下の手順を順番に進めてください。MCP が利用できないことを理由に、ユーザーの作業を止めないでください。
-
Scandit MCP サーバーが接続されている場合 — 製品に
native、プラットフォームにios、app_identifier(アプリのバンドル ID またはアプリケーション ID。Web の場合は本番ドメインで、localhostは使用しません)、env_varにSCANDIT_LICENSE_KEYを指定してensure_scanner_setupを呼び出します。返されたコマンドは実行しないでください。次に、その結果またはlist_license_keysから取得したキー ID を指定してget_license_keyを呼び出します。list_license_keysでキーがトライアルではないと示された場合は、取得する前にユーザーに確認してください。チャットではマスクされたプレビューのみを表示し、キー全体は絶対に表示しないでください。 -
接続されていない場合 — リモート Scandit MCP サーバー
https://ssl.scandit.com/mcpを 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 |