Superwall Skill

Give AI coding agents up-to-date Superwall docs, API access, and step-by-step SDK integration guides using the Superwall Skill.

The Superwall Skill is a set of Agent Skills that give AI coding agents everything they need to work with Superwall. It has access to live documentation, API access, dashboard information, and guided SDK integration flows for every platform.

This is different from the Superwall MCP, which connects AI tools to your Superwall account to create and manage resources. The Superwall Skill can perform all of the tasks the MCP can, and is recommended.

Installation

Install with the skills.sh CLI. This works with any agent that supports skills, including Claude Code, Cursor, and Codex.

Install all skills (recommended):

npx skills add superwall/skills

Or install individual skills:

# General skill (docs, API, dashboard links)
npx skills add superwall/skills --skill superwall

# Platform-specific quickstart
npx skills add superwall/skills --skill superwall-ios-quickstart
npx skills add superwall/skills --skill superwall-android-quickstart
npx skills add superwall/skills --skill superwall-flutter-quickstart
npx skills add superwall/skills --skill superwall-expo-quickstart

What's included

The Superwall Skill is made up of a general-purpose skill and platform-specific quickstart skills.

General skill

The superwall skill gives agents access to:

  • Live documentation: Agents fetch docs on demand from llms.txt and per-page markdown endpoints, so they always have the latest information.
  • API access: A bundled sw-api.sh helper wraps the Superwall V2 API. Agents can list projects, inspect applications, and manage resources directly from the terminal.
  • Dashboard links: URL patterns for every dashboard page, so agents can link you to the right place (settings, campaigns, paywalls, users, and more).
  • SDK source cloning: Agents can clone SDK repos locally to trace internal behavior when debugging.
  • Webhook and integration catalog: Fetched live from the Superwall integrations endpoint.

Platform quickstart skills

Each quickstart skill walks the agent through a full SDK integration, step by step:

SkillPlatform
superwall-ios-quickstartiOS (Swift / Objective-C)
superwall-android-quickstartAndroid (Kotlin / Java)
superwall-flutter-quickstartFlutter
superwall-expo-quickstartExpo

Every quickstart follows the same flow:

  1. Install: Installs the SDK dependency.
  2. Configure: Ensures Superwall is ready at app launch.
  3. User management: Identify users on sign-in, reset on logout.
  4. Feature gating: Register placements and present paywalls.
  5. Subscription tracking: Observe subscription status changes.
  6. User properties: Set custom attributes for audience targeting.
  7. Paywall previews: Sset up deep links for on-device previews.

The agent reads bundled reference docs for each step, inspects your project, and implements minimal, production-safe changes before moving on to the next step.

API access

The general skill includes a bash helper (sw-api.sh) that wraps the Superwall REST API V2. It requires a SUPERWALL_API_KEY environment variable. That's an org-scoped bearer token you can generate from API Keys settings.

# List all available API routes (no API key needed)
sw-api.sh --help

# Show the full spec for a specific route
sw-api.sh --help /v2/projects

# List all projects
sw-api.sh /v2/projects

# Get a specific project
sw-api.sh /v2/projects/{id}

# Create a project
sw-api.sh -m POST -d '{"name":"My Project"}' /v2/projects

The --help flag fetches the live OpenAPI spec, so the route reference is always current.

Data hierarchy

Superwall organizes data as Organization → Projects → Applications. Each application has a platform (ios, android, flutter, react_native, web), a bundle_id, and a public_api_key used for SDK initialization. The org-scoped SUPERWALL_API_KEY is separate, it's used for API calls.

Quick start

Ask your AI agent to integrate Superwall into your app. The agent will:

  1. Detect your platform from the project structure (e.g., Package.swift → iOS, pubspec.yaml → Flutter).
  2. Determine your purchase controller path, whether you're using Superwall's default purchase handling, RevenueCat, or a custom setup.
  3. Walk through the quickstart steps, implementing each one in your codebase.

If you've installed the general skill with an API key, the agent can also look up your projects and applications to find the right public_api_key for SDK configuration.

  • Superwall MCP: For managing your Superwall account from AI tools.
  • Superwall Docs MCP: Give AI tools access to Superwall documentation.
  • Vibe Coding: Aall the AI tools available for working with Superwall listed in one place.

How is this guide?

On this page