{"title":"Adyen Model Context Protocol (MCP) server","category":"default","creationDate":1684483080,"content":"<div class=\"additional-info-block output-inline\">\n<h5 class=\"article__heading additional-info-block__title\">Learn more<\/h5><div class=\"additional-info-block__body\"><p>Read more about the launch of our MCP server in our <a href=\"https:\/\/www.adyen.com\/knowledge-hub\/mcp-release\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">tech blog<\/a>.<\/p><\/div><\/div>\n\n<p><a href=\"https:\/\/github.com\/Adyen\/adyen-mcp\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Our Model Context Protocol (MCP) server<\/a> lets you use natural language with your chosen Large Language Model (LLM) client. This allows developers to use natural language to connect with Adyen's platform more easily and build new payment solutions faster.<\/p>\n<h2>How it works<\/h2>\n<p>Use our MCP server to integrate with our APIs through function calling. This lets you integrate and interact with Adyen APIs seamlessly. The MCP contains a set of tools that lets you interact with the Adyen APIs for common use cases, using your client of choice.<\/p>\n<p>Currently, interactions with the following APIs are supported, we are working on adding more APIs and endpoints.<\/p>\n<ul>\n<li>\n <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Checkout API<\/a>\n<\/li>\n<li>\n <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Management API<\/a>\n<\/li>\n<\/ul>\n<p>For a full overview of supported endpoints, see the list on  <a href=\"https:\/\/github.com\/Adyen\/adyen-mcp\/tree\/main?tab=readme-ov-file#adyen-mcp-server---alpha\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a>.<\/p>\n<p>To get started:<\/p>\n<ol>\n<li><a href=\"#get-api-credentials\">Get your API credentials<\/a> to authenticate the API requests you will make with our MCP server.<\/li>\n<li><a href=\"#run\">Run the MCP server<\/a>.<\/li>\n<li><a href=\"#use\">Use our MCP<\/a> with an LLM client to interact with our APIs using natural language.<\/li>\n<\/ol>\n<h2 id=\"get-api-credentials\">Get your API credentials<\/h2>\n<p>To authenticate the requests you will make using the MCP, <a href=\"\/development-resources\/api-credentials#generate-api-key\">generate an API key<\/a>. You will need your API key when <a href=\"#run\">running the MCP server<\/a>.<\/p>\n<p>Make sure that your API credential has the following <a href=\"\/development-resources\/api-credentials\/roles\">roles<\/a>, these roles are assigned to all web service users by default:<\/p>\n<ul>\n<li>Merchant PAL webservice role<\/li>\n<li>Checkout webservice role<\/li>\n<li>Management API\u2014Payment methods read<\/li>\n<li>Management API\u2014Account read<\/li>\n<li>Management API - Terminals read<\/li>\n<li>Management API \u2014 Assign Terminal<\/li>\n<li>Management API \u2014 Terminal actions read<\/li>\n<li>Management API \u2014 Terminal actions read and write<\/li>\n<li>Management API \u2014 Android files read<\/li>\n<li>Management API \u2014 Terminal settings read<\/li>\n<li>Management API \u2014 Terminal settings read and write<\/li>\n<\/ul>\n<h2 id=\"run\">Run the MCP server<\/h2>\n<p>Run our MCP server locally to start interacting with our APIs using natural language. You need your API key to run the server, and authenticate API requests.<\/p>\n<h3>Test environment<\/h3>\n<p>You must have the following to run the MCP server for the test environment:<\/p>\n<ul>\n<li>Your <a href=\"\/development-resources\/api-credentials\/\">Adyen API key<\/a>.<\/li>\n<\/ul>\n<p>Run the following command:<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"text\",\"tabTitle\":\"\",\"content\":\"npx -y @adyen\\\/mcp --adyenApiKey=ADYEN_API_KEY --env=TEST\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h3>Live environment<\/h3>\n<p>You must have the following to run the MCP server for the live environment:<\/p>\n<ul>\n<li>Your <a href=\"\/development-resources\/api-credentials\/\">Adyen API key<\/a>.<\/li>\n<li>Your <a href=\"\/development-resources\/live-endpoints\/#live-url-prefix\">Adyen live URL prefix<\/a>  from your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a> under <strong>Developers<\/strong> &gt; <strong>API URLs<\/strong> &gt; <strong>Prefix<\/strong>.<\/li>\n<\/ul>\n<p>Run the following command:<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"text\",\"tabTitle\":\"\",\"content\":\"npx -y @adyen\\\/mcp --adyenApiKey=ADYEN_API_KEY --env=LIVE --livePrefix=YOUR_PREFIX_URL\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2 id=\"use\">Use the MCP server<\/h2>\n<p>After you start running the MCP server locally, use an LLM client of your choice to interact with our APIs using natural language.<\/p>\n<p>Interactions with our MCP server consist of the following:<\/p>\n<ul>\n<li><strong>Your prompt<\/strong>: You provide instructions to your LLM client using natural language. For example, \"Refund order #12345\" or \"Create a \u20ac50 payment link for order #ABC789.\"<\/li>\n<li><strong>LLM client<\/strong>: Your LLM client sends these instructions to the Adyen MCP server.<\/li>\n<li><strong>The MCP server<\/strong>: Our MCP server uses converts these instructions into the specific Adyen API requests needed to perform the task using function calling.<\/li>\n<li><strong>API request<\/strong>: The MCP server makes the API requests to carry out the task you asked for, like making a refund or creating a payment link.<\/li>\n<\/ul>\n<h2>See also<\/h2>\n<ul>\n<li><a href=\"\/development-resources\/api-credentials\/\">API credentials<\/a><\/li>\n<li><a href=\"https:\/\/github.com\/Adyen\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Adyen on GitHub<\/a><\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/development-resources\/mcp-server","articleFields":{"description":"Integrate with our APIs using LLMs with our MCP server.","feedback_component":true,"id":"42834702","type":"page","operations":"","status":"current","filters_component":false,"decision_tree":"[]","page_id":"0b33108c-b084-4aef-970b-44c2d09f7d4c","last_edit_on":"11-06-2025 14:59"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/mcp-server","title":"Adyen Model Context Protocol (MCP) server","content":"\nLearn moreRead more about the launch of our MCP server in our tech blog.\n\nOur Model Context Protocol (MCP) server lets you use natural language with your chosen Large Language Model (LLM) client. This allows developers to use natural language to connect with Adyen's platform more easily and build new payment solutions faster.\nHow it works\nUse our MCP server to integrate with our APIs through function calling. This lets you integrate and interact with Adyen APIs seamlessly. The MCP contains a set of tools that lets you interact with the Adyen APIs for common use cases, using your client of choice.\nCurrently, interactions with the following APIs are supported, we are working on adding more APIs and endpoints.\n\n\n Checkout API\n\n\n Management API\n\n\nFor a full overview of supported endpoints, see the list on  GitHub.\nTo get started:\n\nGet your API credentials to authenticate the API requests you will make with our MCP server.\nRun the MCP server.\nUse our MCP with an LLM client to interact with our APIs using natural language.\n\nGet your API credentials\nTo authenticate the requests you will make using the MCP, generate an API key. You will need your API key when running the MCP server.\nMake sure that your API credential has the following roles, these roles are assigned to all web service users by default:\n\nMerchant PAL webservice role\nCheckout webservice role\nManagement API\u2014Payment methods read\nManagement API\u2014Account read\nManagement API - Terminals read\nManagement API \u2014 Assign Terminal\nManagement API \u2014 Terminal actions read\nManagement API \u2014 Terminal actions read and write\nManagement API \u2014 Android files read\nManagement API \u2014 Terminal settings read\nManagement API \u2014 Terminal settings read and write\n\nRun the MCP server\nRun our MCP server locally to start interacting with our APIs using natural language. You need your API key to run the server, and authenticate API requests.\nTest environment\nYou must have the following to run the MCP server for the test environment:\n\nYour Adyen API key.\n\nRun the following command:\n\n    \n\nLive environment\nYou must have the following to run the MCP server for the live environment:\n\nYour Adyen API key.\nYour Adyen live URL prefix  from your live Customer Area under Developers &gt; API URLs &gt; Prefix.\n\nRun the following command:\n\n    \n\nUse the MCP server\nAfter you start running the MCP server locally, use an LLM client of your choice to interact with our APIs using natural language.\nInteractions with our MCP server consist of the following:\n\nYour prompt: You provide instructions to your LLM client using natural language. For example, \"Refund order #12345\" or \"Create a \u20ac50 payment link for order #ABC789.\"\nLLM client: Your LLM client sends these instructions to the Adyen MCP server.\nThe MCP server: Our MCP server uses converts these instructions into the specific Adyen API requests needed to perform the task using function calling.\nAPI request: The MCP server makes the API requests to carry out the task you asked for, like making a refund or creating a payment link.\n\nSee also\n\nAPI credentials\nAdyen on GitHub\n","type":"page","locale":"en","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Adyen Model Context Protocol (MCP) server"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"\/development-resources\/mcp-server"},"levels":3,"category":"Development Resources","category_color":"green","tags":["Adyen","Model","Context","Protocol","(MCP)","server"]}}