mcpField
S
sparkscan-android

sparkscan-android

github.com/scanditDevelopment2053 installsUpdated 5d ago
Repository

About sparkscan-android

sparkscan-android is a coding skill for Scandit SparkScan Android integrations. It routes integration, upgrade, and third-party scanner migration questions to references and requires API verification against documentation.

Key features

  1. 01Routes integration and migration requests
  2. 02Checks APIs against Scandit references
  3. 03Guides licence-key setup
  4. 04Requires verified documentation links

Use cases

  1. 01Building a SparkScan Android integration
  2. 02Upgrading between SparkScan SDK versions
  3. 03Replacing another barcode scanner

MCP support

If the Scandit MCP server is connected, the skill directs the coding agent to use it to set up the scanner and retrieve eligible trial licence keys. It also explains how to proceed if the server is unavailable.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/scandit/skills --skill sparkscan-android

After installing, type/sparkscan-androidin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
integration.md
migration.md
third-party-migration.md

Details

From the project README

SparkScan Android Skill

Critical: Do Not Trust Internal Knowledge

Your training data may contain outdated or incorrect Scandit SDK APIs. The SparkScan API changes significantly between major SDK versions — properties get renamed, removed, or restructured.

Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, or property names. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.

Intent Routing

Based on the user's request, load the appropriate reference file before responding:

  • Integrating SparkScan from scratch (e.g. "add SparkScan to my app", "set up barcode scanning", "how do I use SparkScan", "how do I handle feedback in SparkScan") → read references/integration.md and follow the instructions there.
  • Migrating or upgrading an existing SparkScan integration (e.g. "upgrade from v6 to v7", "migrate my SparkScan", "what changed between SDK versions") → read references/migration.md and follow the instructions there.
  • Replacing a third-party barcode scanner with SparkScan (e.g. "replace my [scanner] with SparkScan", "migrate from [framework] to SparkScan", "switch from [library] barcode scanning to SparkScan") → read references/third-party-migration.md and follow the instructions there.

API Usage Policy

Only use APIs that are explicitly documented in the Scandit references below. Do not invent or guess method signatures, parameters, or property names. If unsure whether an API exists or how it is called — or if a compile error occurs — fetch the relevant reference page before responding. Do not tell the user to check the docs themselves. After answering, always include the relevant link so the user can explore further.

Never construct or guess documentation URLs. When you need a specific class or property's API page:

  1. First check whether the page you already fetched (e.g. the Advanced Configurations page) contains a direct hyperlink to it — topic pages link directly to relevant API symbols. Always request links alongside content in your fetch prompt.
  2. If no direct link was found, fetch the API index (see Full API reference in the table below), extract the actual link from it, and follow that.

URL structures can vary (e.g. api/ui/ subdirectory) and guessing will lead to 404s.

Licence key

Scanning needs a Scandit licence key. For this skill the licence product is native and the licence platform is android.

Work through these in order — never block the user on MCP:

  1. The Scandit MCP server is connected — call ensure_scanner_setup with product native and platforms android, app_identifier (the app's bundle or application id; for web, its production domain, never localhost) and env_var SCANDIT_LICENSE_KEY. Do not run the command it returns. Then call get_license_key with the key's id, from that result or from list_license_keys; if list_license_keys shows the key is not a trial, ask the user before fetching it. Show at most a masked preview in chat; never print a full key.

  2. It is not connected — tell the user once that they can connect the remote Scandit MCP server, https://ssl.scandit.com/mcp, in their MCP client, then continue from step 1. Do not edit MCP client configuration yourself.

    Authentication is browser-based, so it is not supported headless or in CI. The server provisions trial keys only; it never creates, revokes, or modifies production licences.

  3. The user declines, or has no MCP client — they generate a key themselves at https://ssl.scandit.com (no account yet: https://ssl.scandit.com/dashboard/sign-up?p=test) and paste it in.

Then put the key into the code: write it into the licence-key call in place of the placeholder — the key get_license_key returned, or the one the user pastes or gives you — still showing only a masked preview in chat. Do not search the project, its files or the environment for a key.

References

Direct users to the right resource based on their question:

TopicResource
Get StartedGet Started · Sample
Advanced topics (custom feedback, hardware triggers, scanning modes, UI customization)Advanced Configurations
Full API referenceSparkScan API

Comments

Markdown supported