MCP Tool Documentation

Returns the Magento store configuration: name, base URL, locale, timezone, currency.

Lists products with filters for search, status, SKU, visibility, and price. Supports pagination.

Gets full details for a single product by SKU, including price, inventory, and attributes.

Gets product details by internal Magento entity ID (numeric product ID), including custom attributes and extension attributes.

Updates a product's price, name, description, status, visibility, weight, or custom attributes.

Duplicates an existing product to a new SKU with optional name and price overrides.

Returns the full category tree structure with IDs, names, parent relationships, and hierarchy.

Lists orders with filters for status, customer email, and date range. Supports pagination.

Gets full order details by entity ID including items, addresses, and payment info.

Gets order details by increment ID (order number like 000000123).

Creates an invoice for an order. Supports partial invoicing and capture-online payment.

Creates a shipment for an order with optional tracking information and carrier details.

Cancels a pending or processing order. Can optionally add an order history comment after cancellation.

Creates a credit memo (refund) for an invoiced order. Supports partial refunds and adjustment fees.

Adds internal or customer-visible comments to order history.

Analyzes failed orders within a date range to identify root causes (payment declines, fraud reviews, inventory issues, shipping problems). Returns detailed diagnostics with recommended remediation actions.

Generates aggregated sales report with top-selling products. Includes SVG chart visualization.

Searches customers by email, name, or registration date. Supports pagination.

Gets detailed customer profile by ID including addresses, groups, and custom attributes.

Lists all CMS pages with identifiers, titles, and active status.

Gets a CMS page by ID or identifier, including full HTML content.

Creates a new CMS page with title, identifier, content, and SEO metadata.

Updates an existing CMS page content, title, or status.

Lists all CMS blocks (static blocks) with identifiers and titles.

Gets a CMS block by ID or identifier, including content.

Creates a new CMS block with identifier, title, and content.

Updates an existing CMS block content, title, or status.

Lists all shopping cart price rules (discounts) with names, statuses, and discount amounts.

Gets full details of a cart price rule by ID including conditions and actions.

Creates a new cart price rule with discount type, amount, conditions, and date range.

Updates an existing cart price rule discount, status, or conditions.

Lists coupon codes for a cart price rule with usage counts and expiration dates.

Generates multiple coupon codes for a cart price rule with optional prefix, suffix, and format.

Gets details of a specific coupon code including usage stats and associated rule.

Deletes a specific coupon code by code or coupon ID.

Updates coupon details such as usage limits or expiration date.

Lists products with stock quantity below a specified threshold.

Gets stock item details for a product SKU including quantity, status, and manage stock setting.

Updates stock quantity and in-stock status for a single SKU.

Updates stock quantities for multiple SKUs in a single operation. Supports batch processing with error handling.

Returns bestselling products based on order data with quantity and revenue totals.

Aggregated sales data grouped by day, week, or month with revenue and order counts.

Sales breakdown by product category with revenue totals and product counts.

Lists abandoned shopping carts with customer email, cart value, and items.

Top customers ranked by total purchase value with order counts.

Coupon usage statistics with revenue generated and usage counts per code.

Flushes or cleans Magento cache types (config, layout, block_html, etc.).

Lists all indexers from the ayasoftware/magento2-mcp-api extension API.

Gets details of a specific indexer by ID.

Lists status of all indexers (Ready, Processing, Reindex Required).

Gets status of a specific indexer by ID.

Reindexes all Magento indexers.

Reindexes a specific indexer by ID.

Simplified reindex interface: reindexes all invalid indexers (no params) or specific indexers by ID array. Alias for mg_indexer_reindex but with cleaner interface.

Lists product reviews with ratings, titles, and approval status. Supports filtering and pagination.

Gets detailed information about a specific review by ID.

Approves a pending review by ID. Changes status to "Approved" (status_id=2). Idempotent - safely handles already-approved reviews.

Rejects a review by ID. Changes status to "Not Approved" (status_id=3). Idempotent - safely handles already-rejected reviews.

Batch-approves multiple reviews (max 25 per call). Returns success/failure for each review ID. Skips already-approved reviews.

Batch-rejects multiple reviews (max 25 per call). Returns success/failure for each review ID. Skips already-rejected reviews.

Audits a product's SEO elements (meta title, meta description, URL key) and returns recommendations for optimization.

Audits a category's SEO elements (meta title, meta description, URL key) and returns recommendations for optimization.

Scans products or categories to detect missing or empty meta titles and descriptions. Supports filtering by category, status, and date range.

Bulk-updates meta titles for products or categories (max 100 per call). Supports batch processing with error handling options.

Bulk-updates meta descriptions for products or categories (max 100 per call). Supports batch processing with error handling options.

Bulk-updates URL keys (slugs) for products or categories (max 50 per call). Automatically creates 301 redirects from old URLs.