commercetools MCP Essentials

An MCP server and toolkit for integrating with the commercetools platform APIs.

[!IMPORTANT] Commerce MCP is provided free of charge as an early access service. Our Service Level Agreement do not apply to Commerce MCP, and it is provided on an "as-is" basis.

This repository contains both a MCP server (which you can integrate with many MCP clients) and agent essentials that can be used from within agent frameworks.

To run the commercetools MCP server using npx, use the following command:

Client Credentials Authentication (Default)

# To set up all available tools (authType is optional, defaults to client_credentials) npx -y @commercetools/mcp-essentials --tools=all --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL # Explicitly specify client_credentials (optional) npx -y @commercetools/mcp-essentials --tools=all --authType=client_credentials --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL # To set up all read-only tools npx -y @commercetools/mcp-essentials --tools=all.read --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL

# To set up specific tools npx -y @commercetools/mcp-essentials --tools=products.read,products.create --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL

# To set up all available tools with access token npx -y @commercetools/mcp-essentials --tools=all --authType=auth_token --accessToken=ACCESS_TOKEN --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL # To set up all read-only tools with access token npx -y @commercetools/mcp-essentials --tools=all.read --authType=auth_token --accessToken=ACCESS_TOKEN --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL

Make sure to replaceCLIENT_ID,CLIENT_SECRET,PROJECT_KEY,AUTH_URL,API_URL, andACCESS_TOKENwith your actual values. If using the customerId parameter, replaceCUSTOMER_IDwith the actual customer ID. Alternatively, you could set the API_KEY in your environment variables.

To view information on how to develop the MCP server, seethis README.
To view information on how to locally run the bootstrapped MCP server, seethis README.

[!IMPORTANT] To load all the available tools set--tools=alland--isAdmin=true, all the available tools will be loaded into the MCP server. To limit the number of loaded tools set--tools=all.readfor read-only tools or--tools=carts.read,quote.create,quote.read,...To disable dynamic tools loading set thedynamicToolLoadingThresholdto a very high value e.g--dynamicToolLoadingThreshold=650.

To view information on how to develop the MCP server, seethis README.
To view information on how to locally run the bootstrapped MCP server, seethis README.

Refer to ourofficial public documentationfor a more advanced and comprehensive guide on how to get the most out of our MCP offerings.

Interact with the Appwrite API to manage your backend services.