VTEX MCP Server

Overview

what is VTEX MCP Server?

VTEX MCP Server is an API that enables e-commerce analytics and order management through the VTEX platform. It facilitates various business intelligence tasks using a user-friendly interface for enterprise e-commerce operations.

how to use VTEX MCP Server?

To use the VTEX MCP Server, obtain API credentials from your VTEX admin panel, configure your Claude Desktop application to include your credentials and account information, and employ the various analytics and order management tools for specific tasks like performance analysis and order tracking.

key features of VTEX MCP Server?

Business Intelligence Tools: Comprehensive analytics for performance ranking, trend analysis, and competitive insights across brands, categories, products, and more.

Order Management: Advanced order search, filtering, and aggregation capabilities with multi-dimensional statistics.

Performance Overview: Complete business health snapshots with all key metrics (revenue, orders, AOV, conversion rate, sessions) in single calls.

Filter Discovery: Automatic discovery of available filter values for accurate analytics filtering and data exploration.

Token-Optimized Data: Efficient data formats optimized for AI/LLM consumption with tuple structures and metadata.

use cases of VTEX MCP Server?

Managing VTEX e-commerce performance analytics programmatically.

Automating business intelligence reporting and KPI monitoring across multiple store dimensions.

Facilitating data-driven decision making through order pattern analysis and sales performance tracking.

Identifying top/bottom performers, growth trends, and optimization opportunities in real-time.

Configuration

Claude Desktop Setup

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "vtex": {
      "command": "npx",
      "args": [
        "-y",
        "vtex-mcp",
        "--appKey",
        "<YOUR_APP_KEY>",
        "--appToken", 
        "<YOUR_APP_TOKEN>",
        "--account",
        "<YOUR_VTEX_ACCOUNT_NAME>"
      ]
    }
  }
}

Config file locations:

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

Available Tools

Analytics Tools

get_performance_overview - Get comprehensive business health snapshot with all key metrics in a single call

breakdown_metrics_by_dimension - Rank and compare performance within business dimensions (brands, categories, products, etc.)

get_filter_options - Discover available filter values for any business dimension

track_conversion_trends - Retrieve conversion rate data over time with period-over-period comparisons

Order Tools

get_orders_count - Get order counts across different time periods (today, yesterday, last week, etc.)

search_orders - Search and filter orders with comprehensive filtering options for individual order details

aggregate_order_data - Retrieve business metrics and aggregated order data with multi-dimensional statistics

FAQ from VTEX MCP Server?

How do I obtain VTEX API credentials?

Visit your VTEX admin panel > Account Settings > API Keys > Generate Keys. Select necessary read permissions for Orders, Catalog, Customer Data, and Analytics.

What's the difference between search_orders and aggregate_order_data?

Use search_orders when you need individual order details and records. Use aggregate_order_data when you need summarized metrics, counts, and business intelligence insights.

How do I find exact filter values for analytics tools?

Always use get_filter_options first to discover available filter values before using breakdown_metrics_by_dimension for accurate filtering and analysis.

Is there a limit on the date ranges I can query?

Yes, date ranges are limited to a maximum of 90 days for all analytics and order tools to ensure optimal performance.

Can I use VTEX MCP Server for any VTEX store?

Yes! The server works with any VTEX store account. Just provide your specific account name, app key, and app token in the configuration.

License

Business Source License 1.1 (BUSL-1.1) - See LICENSE file for details.