viewa/docs

Agent Skill

An installable skill that walks your coding agent through the whole integration.

In progress. The skill ships alongside the API's general availability — the walkthrough sections for the widget and raw-API paths are finalised against the live surface before release.

The fastest way to integrate Viewa is to let your coding agent do it. The viewa-ecommerce-integration skill gives any Agent Skills compatible agent — Claude Code, Codex, Copilot, Cursor, Gemini CLI, and others — a structured, checkpointed walkthrough of the entire implementation.

Install

Installation goes live with the API's general availability, when this site is published at docs.viewa.sh. Until then the command below will not resolve.

npx skills add https://docs.viewa.sh

Or point your agent at the skill directly: docs.viewa.sh/skill.md

What it does

The skill drives your agent through the integration in verified phases:

  1. Preflight — detects your e-commerce platform (Shopify, WooCommerce, custom storefront), confirms API keys are in place, and pings your catalog.
  2. Auth wiring — publishable vs secret key placement, domain allowlist checks.
  3. Catalog wiring — maps your store's products (and your own SKUs, via aliasing) to the Viewa catalog.
  4. Path choice — widget embed or raw API, with a platform-aware recommendation.
  5. Implementation — the chosen path, end to end.
  6. Verification — a real render, completed and displayed, on your own instance.
  7. Hardening — error handling by stable codes, rate-limit backoff, privacy obligations.

It finishes by writing a VIEWA_INTEGRATION.md summary into your repo — a record of what was integrated where, and the first thing our support team will ask for.

What to expect

The skill is thin by design: it orchestrates, and defers every API fact to this documentation site, which your agent reads as it works — so it is always in sync with the live API.

Your agent will stop and ask you at three points: placing API keys (it will never accept them in conversation — see why), choosing the integration path, and deciding where visualiser entry points belong in your store's UI.

On this page