Adyen MCP Server - Alpha
The Adyen Model Context Protocol (MCP) server allows you to integrate with Adyen APIs through LLMs function calling utilizing various clients. It currently supports the following tools. Read more on our Blog - Part 1.
- CheckoutAPI - Sessions
- CheckoutAPI - Payment Links
- Checkout API - Modifications
- Management API - Accounts
- Gets a list of merchant accounts for your company account - GET
/merchants
- Management API - Terminals
- Management API - Webhooks
- Management API - Payment methods
- Management API - Users
- Management API - API Credentials
- Management API - Allowed Origins
Usage
- Set the
ADYEN_API_KEY environment variable without exposing the key in your shell history:
read -s ADYEN_API_KEY
export ADYEN_API_KEY
- Run the MCP server via
npx with the following command:
npx -y @adyen/mcp --env=TEST
If you are using the LIVE environment then you must also provide your live URL prefix, for example:
npx -y @adyen/mcp --env=LIVE --livePrefix=YOUR_PREFIX_URL
We advise to only run a subset of tools required for your particular use case:
npx -y @adyen/mcp --env=TEST --tools=list_all_company_webhooks,list_all_merchant_webhooks
Example usage in .vscode:
{
"servers": {
"adyen-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@adyen/mcp", "--env=TEST"],
"env": {
"ADYEN_API_KEY": "${ADYEN_API_KEY}"
}
}
}
}
Note: To run certain functionality (tools) in the mcp-server, you need a webservice user with the following roles:
- Management API - Accounts Read
- Management API - Payment methods Read
- Checkout Webservice Role
- Merchant PAL Webservice Role
- Management API - Terminals read
- Management API — Assign Terminal
- Management API — Terminal actions read
- Management API — Terminal actions read and write
- Management API — Android files read
- Management API — Terminal settings read
- Management API — Terminal settings read and write
- Management API — Webhooks read
- Management API — Webhooks read and write
- Management API — Payment methods read
- Management API — API credentials read
- Trigger webhook notifications
Adyen recommends creating a new webservice user and generating a new API key for the purpose of this application.
Only use the new user’s API key for the MCP application and limit the roles to match the tools you'll be using.
License
MIT license. For more information, see the LICENSE file.
Contributing
We strongly encourage you to contribute to our repository. Find out more in our contribution guidelines. If you'd like to run this in Codespaces, follow this guide.
Support
If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact: devrel@adyen.com