Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.waniwani.ai/llms.txt

Use this file to discover all available pages before exploring further.

The WaniWani SDK is available as an agent skill for Claude Code, Cursor, GitHub Copilot, and 20+ other AI coding agents. Once installed, your agent knows how to integrate the SDK without you having to explain the API.

WaniWani SDK

Tracking, flows, widgets, knowledge base, and chat components.

OpenAI Submission

Generate Tool Justification and Test Cases for the ChatGPT App Store.

WaniWani SDK

Install

npx skills add WaniWani-AI/sdk -s waniwani-sdk
The skill is installed into your project’s .claude/skills/ directory (or equivalent for other agents).

What’s included

The skill teaches your agent how to:
  • Set up the SDK — install, configure env vars, create a client singleton
  • Track eventswithWaniwani auto-tracking, custom events, sessions
  • Build flows — multi-step conversational state machines with interrupts, validation, conditional edges
  • Create tools with widgetscreateResource, createTool, React hooks for widget UIs
  • Add a knowledge base — ingest markdown, search with embeddings, build FAQ tools
  • Embed chat — React component and script-tag embed with theming

Usage

After installing, just describe what you want in natural language. Your agent will use the skill automatically:
  • “Add WaniWani tracking to my MCP server”
  • “Create a multi-step onboarding flow”
  • “Add a knowledge base FAQ tool”
  • “Embed a chat widget on my landing page”

OpenAI App Submission

When submitting your MCP server to the ChatGPT App Store, you need to provide Tool Justification and Test Cases documents. The WaniWani dashboard handles this for you: go to your project’s submission page and use the built-in Codex assistant to generate a chatgpt-app-submission.json file, then upload it to auto-fill the form. The generated file includes:
  1. Tool Justification — annotations (Read Only, Open World, Destructive) with justifications for every tool
  2. Test Cases — positive and negative test scenarios for OpenAI reviewers

Learn more