@airwallex/developer-mcp/dist/constants/descriptions.js

MCP server for AI agents that assist developers integrating with the Airwallex platform

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.TOOL_DESCRIPTIONS = void 0;
exports.TOOL_DESCRIPTIONS = {
    CREATE_BILLING_CHECKOUT: `Create a billing checkout session for a single price in the authenticated Sandbox account.
    
This tool creates a billing checkout session and returns a hosted checkout URL that can be shared.

EXAMPLES:
• One-time payment: mode=PAYMENT, price_id=pri_xxx
• Monthly subscription: mode=SUBSCRIPTION, price_id=pri_xxx`,
    CREATE_BILLING_PRICE: `Create a new price for a billing product in the authenticated Sandbox account.

EXAMPLES:
• Ecommerce product: type=ONE_OFF, pricing_model=PER_UNIT
• Monthly subscription: type=RECURRING, pricing_model=FLAT, recurring_period=1, recurring_period_unit=MONTH
• Bi-weekly: type=RECURRING, recurring_period=2, recurring_period_unit=WEEK
• Yearly: type=RECURRING, recurring_period=1, recurring_period_unit=YEAR`,
    CREATE_BILLING_PRODUCT: `Create a new billing product in the authenticated Sandbox account.`,
    CREATE_PAYMENT_LINK: `Create a payment link in the authenticated Sandbox account and optionally send it via email to a shopper.`,
    CREATE_TRANSFER: `Create a new transfer to an existing beneficiary in the authenticated Sandbox account.
  
  Either transfer_amount OR source_amount must be provided, but not both.`,
    GET_ACCOUNT_BALANCES: `Retrieve balances for all currencies in the authenticated Sandbox account.

PRESENTATION REQUIREMENT: When presenting the results to the user, you MUST format the balance data as a clear table showing each currency with its corresponding balance amounts. Create a table with columns for Currency, Available, Pending, Reserved, Total, and Prepayment amounts.

RESPONSE: Amounts returned are NOT in minor units.`,
    GET_FX_QUOTE: `Get a foreign exchange quote for a currency conversion in the authenticated Sandbox account.`,
    LIST_BENEFICIARIES: `List all beneficiaries in the authenticated Sandbox account.`,
    LIST_BILLING_PRICES: `List billing prices in the authenticated Sandbox account.`,
    LIST_BILLING_PRODUCTS: `List all billing products in the authenticated Sandbox account.`,
    LIST_GLOBAL_ACCOUNTS: `List all global accounts in the authenticated Sandbox account.`,
    LIST_PAYMENT_LINKS: `List all payment links in the authenticated Sandbox account.

This tool retrieves a list of all payment links created by the merchant.`,
    LIST_TRANSFERS: `List all transfers in the authenticated Sandbox account.`,
    READ_BEST_PRACTICES: `CODE GENERATION ONLY: This tool MUST be called before any other Airwallex tools, but ONLY when the user intent is to generate code. For documentation searches, general questions, or non-code-related tasks, skip this tool and proceed directly with the appropriate tools for the task at hand.

SINGLE USE PER CONVERSATION: You MUST call this tool only ONCE per conversation. The best practices content is static and doesn't need to be re-read multiple times.

This tool reads the Airwallex integration best practices documentation that contains essential guidelines for API usage, payment handling, SDK implementation, and common pitfalls to avoid.`,
    RETRIEVE_DOCS: `Retrieve relevant sections from the official Airwallex documentation matching the user's question.
  
USAGE STRATEGY:
  DO: Prefer to start with a broad search without specifying any source and then narrow down the search with a specific source when needed
  DO: For relevant API endpoints or SDK methods in the sections returned, invoke this tool again with the specific source to get more detailed information
  DO: For API endpoints referenced, always remember to explicitly check how to perform API authentication
  DO: For SDK methods referenced, always remember to explicitly check how to initialize the SDK

PRIVACY & SECURITY REQUIREMENTS:
• DON'T: Include PII (Personally Identifiable Information) in questions
• DON'T: Include account IDs, user IDs, email addresses, or customer data
• DON'T: Include API keys, tokens, or credentials
• DON'T: Include transaction IDs, payment references, or financial data
• DO: Use generic examples like 'how to process payments' instead of specific account details
• DO: Focus on technical concepts, API endpoints, and implementation patterns
• DO: API version information is permitted as an exception (e.g., '2023-09-30')`,
    SIMULATE_DEPOSIT: `Simulate a deposit to a global account in the authenticated Sandbox account.

This tool simulates deposits into your global account for testing payment flows and account balance management.`,
    SIMULATE_TRANSFER_UPDATE: `Simulate a transfer status update in the authenticated Sandbox account.

TRANSFER STATUS LIFECYCLE:
To simulate a successful transfer completion, progress through these states in order:
1. SENT (transfer sent to beneficiary's bank)
3. PAID (transfer successfully completed - final status)`,
    VALIDATE_REQUEST_SCHEMA: `Validate generated code that makes API requests to the Airwallex API.
Validates generated code that involves making API requests to Airwallex API for correctness and quality. 
  **REQUIRED WORKFLOW**: When you generate any code that involves Airwallex APIs for the user, you MUST: 
  (1) Generate the code, 
  (2) Immediately call this validation tool, 
  (3) Review validation results, 
  (4) Fix any issues found, 
  (5) Validate again if changes were made, 
  (6) Only present code to user after passing validation. 
  Never skip validation - it ensures that users are protected from broken or unsafe code.
* This tool does NOT execute the API request or return live data. It ONLY checks if the request made (as a result of running the generated code) is valid according to the schema.
* If the request requires input, use sensible example values that match the data type used in the code. 
* If the code uses variables, use placeholder values that match the expected format. 
* If the request body is dynamically generated, perform a validation for each type of variation
* DO NOT use real or sensitive data.
* if AIRWALLEX_API_VERSION is not set, use "latest" as the default version. 
 
This tool validates the request body, headers, query parameters, HTTP method, and route against the Airwallex API schema for the specified version. It helps ensure that requests are correctly formed before sending them to the Airwallex API.`,
};