@airwallex/developer-mcp
Version:
MCP server for AI agents that assist developers integrating with the Airwallex platform
149 lines (103 loc) • 7.54 kB
Markdown
# /developer-mcp
The Airwallex Developer Model Context Protocol (MCP) server empowers AI coding agents with the tools they need to assist developers integrating with [Airwallex APIs](https://www.airwallex.com/docs/api#/Introduction). It enables agents to search Airwallex documentation and interact with the sandbox environment for testing and simulation.
---
## Installation
<details>
<summary><strong>Cursor</strong></summary>
[](https://cursor.com/en-US/install-mcp?name=airwallex-dev&config=eyJlbnYiOnsiQUlSV0FMTEVYX1NBTkRCT1hfQ0xJRU5UX0lEIjoiIiwiQUlSV0FMTEVYX1NBTkRCT1hfQVBJX0tFWSI6IiJ9LCJjb21tYW5kIjoibnB4IC15IEBhaXJ3YWxsZXgvZGV2ZWxvcGVyLW1jcEBsYXRlc3QifQ%3D%3D)
```json
{
"mcpServers": {
"airwallex-dev": {
"command": "npx",
"args": ["-y", "@airwallex/developer-mcp@latest"],
"env": {
"AIRWALLEX_SANDBOX_CLIENT_ID": "",
"AIRWALLEX_SANDBOX_API_KEY": ""
}
}
}
}
```
</details>
<details>
<summary><strong>Claude Code</strong></summary>
```zsh
claude mcp add-json airwallex-dev '{ "type": "stdio", "command":"npx", "args": ["-y", "@airwallex/developer-mcp@latest"], "env": { "AIRWALLEX_SANDBOX_CLIENT_ID": "", "AIRWALLEX_SANDBOX_API_KEY": "" } }'
```
</details>
<details>
<summary><strong>Gemini CLI</strong></summary>
```json
{
"mcpServers": {
"airwallex-dev": {
"command": "npx",
"args": ["-y", "@airwallex/developer-mcp@latest"],
"env": {
"AIRWALLEX_SANDBOX_CLIENT_ID": "",
"AIRWALLEX_SANDBOX_API_KEY": ""
}
}
}
}
```
</details>
<details>
<summary><strong>OpenAI Codex</strong></summary>
```toml
[mcp_servers.airwallex-dev]
command = "npx"
args = ["-y", "@airwallex/developer-mcp@latest"]
[mcp_servers.airwallex-dev.env]
AIRWALLEX_SANDBOX_CLIENT_ID = ""
AIRWALLEX_SANDBOX_API_KEY = ""
```
</details>
---
## Example prompts
_Integrate Airwallex's Drop-in element with this website_
_Using Airwallex, can you find me test card numbers for the 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?_
### With sandbox tools
_Can you create a new billing plan on Airwallex called Startup for $29.99/month and create a hosted URL to subscribe to it?_
---
## Environment variables
To access sandbox tools, ensure that your sandbox API credentials are set using the following environment variables. If you don't already have a sandbox account, create one using [this link](https://demo.airwallex.com/signup/sandbox).
| Name | Description | Default | Required |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `AIRWALLEX_SANDBOX_API_KEY` | The API key, either an admin key or a scoped 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` | Set this variable to `true` to opt out of telemetry. | `0` | No |
---
## Tools
### Developer tools
| Name | Description |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `search_public_docs` | Search the Airwallex documentation. Covers the following sources: [Product docs](https://www.airwallex.com/docs/), [API reference](https://www.airwallex.com/docs/api), [Airwallex.js](https://www.airwallex.com/docs/js/), Payments [iOS](https://github.com/airwallex/airwallex-payment-ios) and [Android](https://github.com/airwallex/airwallex-payment-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_balances` | List balances in all currencies |
| `simulate_create_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_result` | Simulate the status of a transfer |
| `create_payment_link` | Create a new payment link |
| `list_payment_links` | List created payment links |
---
## Disclaimer
This MCP server can help minimize hallucinations in Airwallex-related integration code produced by your coding agent but does not eliminate hallucinations entirely. Please always review, validate, and thoroughly test any AI-generated code before deploying it to production.
## Feedback
This MCP server is developed and maintained by the Airwallex Developer Experience team. We welcome your feedback — please contact us at [`developer.support.com`](mailto:developer.support.com). Remember to mention the AI model your coding agent was connected to.
## Telemetry
Telemetry is enabled by default. To disable telemetry, set the `DISABLE_TELEMETRY` environment variable to `true`. Only anonymous data about MCP tool usage is collected.