Utilities

AI Integration

Using Super Qi documentation with AI tools like ChatGPT and Claude

This documentation is optimized for use with AI tools and Large Language Models (LLMs). You can use our documentation as context for AI assistants to help with your Super Qi Miniapp development.

Available AI-Optimized Files

We provide two static text files that contain the complete documentation in an AI-friendly format:

  • /llms.txt - Condensed version of the documentation
  • /llms-full.txt - Full comprehensive documentation with complete details

How to Use

With ChatGPT, Claude, or Other AI Chats

  1. Copy the documentation URL for your environment:
    • Condensed version: https://superqi-dev-docs.pages.dev/llms.txt
    • Full version: https://superqi-dev-docs.pages.dev/llms-full.txt
  2. In your AI chat, say:
    Please read https://superqi-dev-docs.pages.dev/llms.txt and help me with Super Qi Miniapp development
    
  3. The AI will fetch the documentation and use it to answer your questions

Model Context Protocol (MCP) - To Be Implemented

An MCP (Model Context Protocol) server for Super Qi documentation is currently in development and will be deployed soon. This will provide a more seamless integration experience, allowing AI assistants to directly access and query the documentation through the MCP protocol. Note that MCP requires a server component, while the current documentation solution is plain and simple, using only frontend static files.

Example Queries

Once the AI has loaded the documentation, you can ask questions like:

  • "How do I implement cashier payment in my Miniapp?"
  • "What's the difference between UAT and production credentials?"
  • "Show me how to use the authentication flow"
  • "Help me set up deep links for my Miniapp"
  • "What APIs are available for payment integration?"
  • "How do I handle user authentication tokens?"

Use Cases

Quick Problem Solving

Ask the AI to help debug issues or explain specific concepts from the documentation without manually searching through multiple pages.

Code Examples

Request code snippets and implementation examples based on the API reference and guides in the documentation.

Learning & Onboarding

New team members can use AI to get instant answers while learning the Super Qi platform, making onboarding faster.

While AI can be incredibly helpful, always verify critical implementation details against the official documentation, especially for security-sensitive features like authentication and payments.