LianLian Docs Search Skill

Offline Agent Skill for searching LianLian Global API documentation. No network required, no dependencies to install. Supports doc search + integration code generation.

Quick Start

1. Install

Option 1: npx (recommended)

npx lianlian-docs-search-skill

Auto-detects your AI tool and installs to the correct directory. Or specify a target:

npx lianlian-docs-search-skill kiro     # → .kiro/skills/
npx lianlian-docs-search-skill claude   # → ~/.claude/skills/
npx lianlian-docs-search-skill cursor   # → .cursor/skills/
npx lianlian-docs-search-skill copilot  # → .github/skills/

Option 2: Download zip / git clone

Download from GitHub Releases and extract to the appropriate directory:

| AI Tool | Skills Path | |---------|------------| | Kiro | .kiro/skills/lianlian-docs-search | | Claude Code | ~/.claude/skills/lianlian-docs-search | | Cursor | .cursor/skills/lianlian-docs-search | | GitHub Copilot | .github/skills/lianlian-docs-search |

Or clone directly:

git clone https://github.com/LLGlobal/lianlian-docs-search-skill.git

2. Usage

Once installed, your AI assistant will automatically invoke this Skill when you ask about LianLian APIs.

You can also run it manually:

cd lianlian-docs-search/scripts

# Search documentation
python search_docs.py search "create payout" 5

# Browse all sections
python search_docs.py list

# Browse by category
python search_docs.py list "API Reference"

# Get full endpoint details
python search_docs.py detail "Create a Payout"

Requirements

• Python 3.6+ (standard library only, no pip install needed)
• No network required (all documentation data is bundled in references/)

Directory Structure

lianlian-docs-search/
├── SKILL.md                    # Skill metadata and instructions
├── README.md                   # This document
├── package.json                # npx install support
├── bin/install.js              # Install script
├── scripts/
│   └── search_docs.py         # Search engine (BM25 + synonym expansion)
└── references/
    ├── integration-guide.md    # Integration guide (auth, signature, environments)
    ├── templates/
    │   ├── python_integration.py  # Python integration template
    │   └── java_integration.java  # Java integration template
    ├── llg-os-get-started.json # Guides
    ├── llg-os-api.json         # API Reference (most comprehensive)
    ├── llg-os-business.json    # Business Tutorials
    ├── llg-os-sdk.json         # SDK Reference
    └── llg-os-acquire-r.json   # Acceptance API Reference

Features

| Feature | Description | |---------|-------------| | BM25 ranking | Relevance scoring based on term frequency–inverse document frequency | | Synonym expansion | Searching "payee" also matches "beneficiary", "recipient" | | Substring fallback | Error codes and abbreviations won't be missed | | Category boost | API Reference results rank highest | | Title boost | Title matches rank higher | | Adaptive summaries | Endpoint details show more content, overviews show less |

Search Examples

# How to create a payout
python search_docs.py search "create payout"

# Webhook event format
python search_docs.py search "webhook event notification"

# Authentication and signature
python search_docs.py search "authentication signature"

# Error codes
python search_docs.py search "AB09"

# VBA virtual bank account
python search_docs.py search "virtual bank account"

# Exchange rate API
python search_docs.py search "exchange rate query"

Built-in Synonyms

| Search term | Expands to | |-------------|-----------| | payee | beneficiary, recipient, receiver | | payout | payment, remittance, send | | exchange | conversion, fx, convert | | withdrawal | withdraw, cashout | | webhook | notification, callback, event | | signature | sign, authentication, auth | | contact | payee, beneficiary, recipient | | refund | return, reversal | | kyc | verification, identity, compliance |

Integration Code Generation

Beyond doc search, this Skill includes code templates. When you tell your AI assistant "help me integrate LianLian payout API", it will:

1. Read references/integration-guide.md for authentication details
2. Read code templates from references/templates/
3. Search for the relevant endpoint's parameter schema
4. Generate complete, runnable integration code

Supported scenarios: payout, exchange, withdrawal, VBA, contacts, request payment, webhook verification.

Data Updates

Auto-update: The script fetches the latest docs every 24 hours when online (silently skipped when offline):

| File | Remote URL | |------|-----------| | llg-os-get-started.json | https://docs.lianlianglobal.com/get-started | | llg-os-api.json | https://docs.lianlianglobal.com/api-reference | | llg-os-sdk.json | https://docs.lianlianglobal.com/sdk-reference | | llg-os-business.json | https://docs.lianlianglobal.com/business |

Manual update:

python scripts/search_docs.py update

Fully offline: Replace the JSON files in references/ manually:

cp /path/to/new/llg-os-*.json lianlian-docs-search/references/

FAQ

Q: Search results are truncated? A: Use the detail command with the exact title to get full content.

Q: Can't find what I'm looking for? A: Try English keywords (docs are primarily in English), or use different synonyms.

Q: Does it support Chinese search? A: Documentation content is in English. Use English keywords for best results. AI assistants will handle Chinese-to-English mapping automatically.

Version

• v3.0 — Added integration code generation, npx install, multi-tool support
• v2.0 — Offline version with local BM25 + synonym expansion
• v1.0 — Online version (deprecated)

Feedback

For questions or feedback, contact [email protected].