MCP VTEX Server

You set up the MCP VTEX Server to manage your VTEX-based e-commerce operations through natural language conversations. This server connects Claude Desktop or Cursor with VTEX APIs, enabling you to control catalog, pricing, inventory, orders, marketplace activities, and more from chat or voice commands.

How to use

You operate the MCP VTEX Server from an MCP client (Claude Desktop or Cursor). After configuring the MCP connection, you can issue natural language requests to perform catalog management, pricing, inventory, order processing, marketplace actions, and checkout flows. The MCP server translates your commands into VTEX API calls and returns results in the chat interface, letting you manage your store without switching apps.

How to install

Prerequisites: you need Node.js 18 or higher and a VTEX account with API credentials (App Key and App Token). Ensure you have either Claude Desktop or Cursor with MCP support.

# Install the MCP VTEX Server globally (preferred for some setups)
npm install -g mcp-vtex

# If you prefer running via npx (always latest)
npx -y mcp-vtex

# For local development builds, follow the internal build steps and run the built index
# Build the project (if you have the source locally)
npm install
npm run build
# Run the local runtime (example for Claude Desktop integration)
node dist/index.js

Configuration and startup options

Configure your VTEX credentials and MCP entry points in your client’s MCP settings. You can use either a globally installed MCP binary, an npx invocation, or a local node runtime against a built index.

{
  "mcpServers": {
    "vtex": {
      "command": "mcp-vtex",
      "env": {
        "VTEX_ACCOUNT_NAME": "your-account-name",
        "VTEX_ENVIRONMENT": "vtexcommercestable",
        "VTEX_APP_KEY": "your-app-key",
        "VTEX_APP_TOKEN": "your-app-token"
      }
    }
  }
}

Security and credentials

Never commit credentials to version control. Store API credentials in environment variables and rotate keys regularly. Use separate keys for development and production and grant only the permissions you need.

Troubleshooting

If you cannot connect to VTEX, verify your account name, App Key, and App Token, and ensure the store is active and the credentials have the necessary permissions.

Available tools

Catalog_CreateProduct

Create a new product with full details including category, brand, and specifications.

Catalog_UpdateProduct

Update product attributes such as name, description, and attributes.

Catalog_ListProducts

List products with filters and pagination.

Catalog_CreateSKU

Create a new SKU linked to a product with stock and attributes.

Catalog_UpdateSKU

Update SKU properties including price and stock.

Catalog_ListSKUs

List SKUs for a given product or across the catalog.

Pricing_GetPrice

Retrieve base, list, and computed prices for a SKU.

Pricing_CreateOrUpdatePrice

Create or update price entries for products or SKUs.

Inventory_GetInventory

Get real-time inventory levels across warehouses.

Inventory_UpdateInventory

Update inventory quantities in specific warehouses.

Warehouses_Create

Create a new warehouse facility.

Warehouses_List

List all warehouses.

Docks_Create

Configure a loading dock.

ShippingPolicies_Create

Create shipping methods and rules.

Orders_GetOrder

Fetch details for a specific order.

Orders_List

List orders with filters and date ranges.

Orders_StartHandling

Begin processing an order workflow.

Orders_Cancel

Cancel an order with a reason.

Invoices_Add

Add invoices and tracking information to an order.

Marketplace_GetSellers

List sellers in the marketplace.

Marketplace_InviteSeller

Invite a new seller to join the marketplace.