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 = ""

Best practices

Follow these best practices to get the most out of your AI coding assistant with the Airwallex MCP server.

Always mention "Airwallex" in your prompts

When asking your coding assistant about Airwallex products, APIs, or integrations, explicitly mention "Airwallex" in your prompt. This ensures the agent searches the correct documentation and uses the right context for your request.

Examples:

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?

Use plan mode in Cursor

If you're using Cursor, enable plan mode for complex tasks. This allows you to review the agent's planned actions before execution, ensuring you understand and approve each step of the implementation.

You can activate plan mode in Cursor in either of the following ways:

Select Plan from the agent mode dropdown in Cursor's composer.
Mention it explicitly in your prompt (for example, "Using plan mode, help me integrate Airwallex Embedded Elements").

Be specific with your requirements

Provide detailed context about your use case, including the specific Airwallex product or feature you're working with, your preferred programming language and framework, the environment (sandbox or production), and any specific business requirements or constraints.

Leverage sandbox credentials

Configure your sandbox API credentials to unlock additional MCP tools for testing and simulation. With sandbox credentials, the agent can:

Create test transactions and billing plans.
Simulate transfer status updates.
Generate payment links for testing.
Interact with your sandbox account directly.

This enables end-to-end development and testing workflows without leaving your coding environment.

Example:

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:

Name	Description	Default	Required
`AIRWALLEX_SANDBOX_API_KEY`	The 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/A	No
`AIRWALLEX_SANDBOX_CLIENT_ID`	The Client ID associated with the API Key generated in the Sandbox Environment.	N/A	No
`DISABLE_TELEMETRY`	Telemetry 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.	`0`	No

Tools

Developer tools

Name	Description
`search_public_docs`	Search the Airwallex documentation. Covers the following sources: Product docs, API reference API, Airwallex.js JS, Payments iOS and Android SDKs

Sandbox tools

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

Name	Description
`list_global_accounts`	List all available global accounts
`get_account_balances`	List balances in all currencies
`simulate_global_account_deposit`	Simulate a deposit to an available global account
`list_billing_products`	List available billing products
`list_billing_prices`	List available billing prices
`create_billing_product`	Create a new billing product
`create_billing_price`	Create a new billing price
`create_billing_checkout`	Create a new hosted billing checkout page
`get_fx_quote`	Get a quote for a FX conversion
`list_transfers`	List transfers initiated
`create_transfer`	Initiate a new transfer to a recipient
`list_beneficiaries`	List available transfer recipients
`simulate_transfer_update`	Simulate the status of a transfer
`create_payment_link`	Create a new payment link
`list_payment_links`	List created payment links

Feedback

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