VTEX
@jamesm010
VTEX MCP Server serves as a wrapper for VTEX Commerce APIs, enabling e-commerce analytics for store owners. It facilitates various business intelligence tasks using an LLM client, such as Claude Desktop.
Overview
What is VTEX?
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?
Obtain API credentials from your VTEX admin panel, then configure your Claude Desktop application by adding your app key, app token, and account name to claude_desktop_config.json using the vtex-mcp command via npx.
Key features of VTEX
- Comprehensive analytics for performance ranking, trend analysis, and competitive insights.
- Advanced order search, filtering, and aggregation with multi-dimensional statistics.
- Complete business health snapshots with key metrics in a single call.
- Automatic discovery of available filter values for accurate analytics filtering.
- Token-optimized data formats designed for AI/LLM consumption.
Use cases of VTEX
- Managing VTEX e-commerce performance analytics programmatically.
- Automating business intelligence reporting and KPI monitoring across store dimensions.
- Facilitating data-driven decision making through order pattern and sales performance analysis.
- Identifying top/bottom performers, growth trends, and optimization opportunities in real-time.
FAQ from VTEX
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.
