VTEX
@jamesm010
About VTEX
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.
Config
Add this server to your MCP-compatible client using the configuration below.
{
"mcpServers": {
"vtex": {
"command": "npx",
"args": [
"vtex-mcp",
"--appKey",
"<YOUR_APP_KEY>",
"--appToken",
"<YOUR_APP_TOKEN>",
"--account",
"<YOUR_VTEX_ACCOUNT_NAME>"
]
}
}
}Tools
No tools detected
Fetch the live tool list by running this server in a temporary sandbox using the button above.
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.
Frequently asked questions
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.
Basic information
More AI & Agents MCP servers
Model Context Protocol for Unreal Engine
chongdashuEnable AI assistant clients like Cursor, Windsurf and Claude Desktop to control Unreal Engine through natural language using the Model Context Protocol (MCP).
MCP Server - Remote MacOs Use
baryhuangThe only general AI agent that does NOT requires extra API key, giving you full control on your local and remote MacOs from Claude Desktop App
Perplexity Ask MCP Server
ppl-aiThe official MCP server implementation for the Perplexity API Platform
bsv.cx
Andy RoweTimestamp and verify evidence on-chain. Let your agent prove what it saw and when. bsv.cx gives an AI agent verifiable memory. Timestamp a hash of any output, archive a web page as it looked, or fetch a URL with a recei
Model Context Protocol Server for Home Assistant
tevonsbA MCP server for Home Assistant
Comments