Airwallex logo
Airwallex logo

Developer MCP

Empower AI coding agents with the tools they need to accelerate Airwallex API integrations

The Airwallex Developer Model Context Protocol (MCP) server enables coding agents to search Airwallex documentation and interact with the sandbox environment for testing and simulation.

Before you begin

Before you connect your coding assistant to the Developer MCP server, ensure you have:

  • A compatible AI coding assistant installed (Cursor, Claude Code, or other MCP-compatible tool).
  • Node.js installed and available on your PATH (version 18.x or later).
  • Optional: A sandbox account and sandbox API credentials (Client ID and API Key) if you want to use sandbox tools.

Connect your coding assistant

Cursor

You can use either the one-click installation link or manually configure Cursor.

One-click installation:

Install Airwallex Developer MCP in Cursor

Manual configuration:

Add the following configuration to your Cursor MCP settings:

JSON
1{
2 "mcpServers": {
3 "airwallex-dev": {
4 "command": "npx",
5 "args": ["-y", "@airwallex/developer-mcp@latest"],
6 "env": {
7 "AIRWALLEX_SANDBOX_CLIENT_ID": "",
8 "AIRWALLEX_SANDBOX_API_KEY": ""
9 }
10 }
11 }
12}

Claude Code

Run the following command to configure Claude Code:

Shell
1claude mcp add-json airwallex-dev '{ "type": "stdio", "command":"npx", "args": ["-y", "@airwallex/developer-mcp@latest"], "env": { "AIRWALLEX_SANDBOX_CLIENT_ID": "", "AIRWALLEX_SANDBOX_API_KEY": "" } }'

Gemini CLI

Add the following configuration to your Gemini CLI MCP settings:

JSON
1{
2 "mcpServers": {
3 "airwallex-dev": {
4 "command": "npx",
5 "args": ["-y", "@airwallex/developer-mcp@latest"],
6 "timeout": 30000,
7 "env": {
8 "AIRWALLEX_SANDBOX_CLIENT_ID": "",
9 "AIRWALLEX_SANDBOX_API_KEY": ""
10 }
11 }
12 }
13}

OpenAI Codex

Add the following configuration to your OpenAI Codex MCP settings:

toml
1[mcp_servers.airwallex-dev]
2command = "npx"
3args = ["-y", "@airwallex/developer-mcp@latest"]
4
5[mcp_servers.airwallex-dev.env]
6AIRWALLEX_SANDBOX_CLIENT_ID = ""
7AIRWALLEX_SANDBOX_API_KEY = ""

Example prompts

Once connected, you can use natural language prompts to interact with your coding assistant. Ensure you explicitly mention "Airwallex" when prompting your coding assistant about Airwallex integrations or products. For example:

Documentation and code generation:

  • "Integrate Airwallex's Drop-in Element with this website"
  • "Using Airwallex, can you find me test card numbers for the 3D Secure (3DS) authentication failure case?"
  • "I tried to make a payout with Airwallex and got this error: amount_below_transfer_method_limit. What does that mean?"

Sandbox operations (requires sandbox API credentials):

  • "Can you create a new billing plan on Airwallex called Startup for $29.99/month and create a hosted URL to subscribe to it?"

Configuration

The Developer MCP server supports the following environment variables:

NameDescriptionDefaultRequired
AIRWALLEX_SANDBOX_API_KEYThe API Key, either an admin API Key or a scoped API Key with limited permissions, generated in the Sandbox Environment. Note that the sandbox tools work as expected only if the API Key has the required permissions to access the underlying APIs. Simulation APIs require an admin API Key.N/ANo
AIRWALLEX_SANDBOX_CLIENT_IDThe Client ID associated with the API Key generated in the Sandbox Environment.N/ANo
DISABLE_TELEMETRYTelemetry is enabled by default but can be disabled by setting the DISABLE_TELEMETRY environment variable to true. When enabled, telemetry collects only anonymous data about MCP tool usage (without logging parameters or responses) to help improve the service.0No

Tools

Developer tools

NameDescription
search_public_docsSearch the Airwallex documentation. Covers the following sources: Product docs, API reference, Airwallex.js, Payments iOS and Android SDKs

Sandbox tools

All data retrieved and actions performed with the tools below are in the authenticated sandbox account.

NameDescription
list_global_accountsList all available global accounts
get_account_balancesList balances in all currencies
simulate_global_account_depositSimulate a deposit to an available global account
list_billing_productsList available billing products
list_billing_pricesList available billing prices
create_billing_productCreate a new billing product
create_billing_priceCreate a new billing price
create_billing_checkoutCreate a new hosted billing checkout page
get_fx_quoteGet a quote for a FX conversion
list_transfersList transfers initiated
create_transferInitiate a new transfer to a recipient
list_beneficiariesList available transfer recipients
simulate_transfer_updateSimulate the status of a transfer
create_payment_linkCreate a new payment link
list_payment_linksList created payment links

Feedback

For questions or feedback about the Developer MCP server, contact the Developer Experience team at [email protected].

See also

Was this page helpful?