// API Reference

Magento Store Assistant Documentation

All available tools for controlling your Magento store through an AI agent. Connect via Claude, Codex, or any MCP-compatible client.

71 total tools
14 categories
// See it work

Run your Magento back office
from ChatGPT or Claude.

Investigate failed orders, check sales, find SEO gaps, and update your store in plain language β€” with permissions you control.

2 tool calls
~90 sec start to fix
See a real store workflow Start a 7-day trial
tool mg_seo_audit_product
tool mg_update_product
// Full reference

Every tool, by category.

For developers wiring up a client: all 71 tools below, grouped the way they're documented. Read-only tools run freely; anything that changes data is labelled.

Store Information 1 tool
mg_get_store_info
Returns the Magento store configuration: name, base URL, locale, timezone, currency.
Products 5 tools
mg_list_products
Lists products with filters for search, status, SKU, visibility, and price. Supports pagination.
mg_get_product
Gets full details for a single product by SKU, including price, inventory, and attributes.
mg_get_product_by_id
Gets product details by internal Magento entity ID (numeric product ID), including custom attributes and extension attributes.
mg_update_product
Updates a product's price, name, description, status, visibility, weight, or custom attributes.
mg_duplicate_product
Duplicates an existing product to a new SKU with optional name and price overrides.
Categories 1 tool
mg_list_categories
Returns the full category tree structure with IDs, names, parent relationships, and hierarchy.
Orders 10 tools
mg_list_orders
Lists orders with filters for status, customer email, and date range. Supports pagination.
mg_get_order
Gets full order details by entity ID including items, addresses, and payment info.
mg_get_order_by_increment_id
Gets order details by increment ID (order number like 000000123).
mg_create_invoice
Creates an invoice for an order. Supports partial invoicing and capture-online payment.
mg_create_shipment
Creates a shipment for an order with optional tracking information and carrier details.
mg_cancel_order
Cancels a pending or processing order. Can optionally add an order history comment after cancellation.
mg_create_credit_memo
Creates a credit memo (refund) for an invoiced order. Supports partial refunds and adjustment fees.
mg_add_order_comment
Adds internal or customer-visible comments to order history.
mg_analyze_failed_order
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.
mg_report_top_products
Generates aggregated sales report with top-selling products. Includes SVG chart visualization.
Customers 2 tools
mg_list_customers
Searches customers by email, name, or registration date. Supports pagination.
mg_get_customer
Gets detailed customer profile by ID including addresses, groups, and custom attributes.
CMS 8 tools
mg_list_cms_pages
Lists all CMS pages with identifiers, titles, and active status.
mg_get_cms_page
Gets a CMS page by ID or identifier, including full HTML content.
mg_create_cms_page
Creates a new CMS page with title, identifier, content, and SEO metadata.
mg_update_cms_page
Updates an existing CMS page content, title, or status.
mg_list_cms_blocks
Lists all CMS blocks (static blocks) with identifiers and titles.
mg_get_cms_block
Gets a CMS block by ID or identifier, including content.
mg_create_cms_block
Creates a new CMS block with identifier, title, and content.
mg_update_cms_block
Updates an existing CMS block content, title, or status.
Cart Price Rules 4 tools
mg_list_cart_rules
Lists all shopping cart price rules (discounts) with names, statuses, and discount amounts.
mg_get_cart_rule
Gets full details of a cart price rule by ID including conditions and actions.
mg_create_cart_rule
Creates a new cart price rule with discount type, amount, conditions, and date range.
mg_update_cart_rule
Updates an existing cart price rule discount, status, or conditions.
Coupons 5 tools
mg_list_coupons
Lists coupon codes for a cart price rule with usage counts and expiration dates.
mg_generate_coupons
Generates multiple coupon codes for a cart price rule with optional prefix, suffix, and format.
mg_get_coupon
Gets details of a specific coupon code including usage stats and associated rule.
mg_delete_coupon
Deletes a specific coupon code by code or coupon ID.
mg_update_coupon
Updates coupon details such as usage limits or expiration date.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.2.0
Inventory 4 tools
mg_get_low_stock
Lists products with stock quantity below a specified threshold.
mg_get_stock_status
Gets stock item details for a product SKU including quantity, status, and manage stock setting.
mg_update_stock
Updates stock quantity and in-stock status for a single SKU.
mg_bulk_update_stock
Updates stock quantities for multiple SKUs in a single operation. Supports batch processing with error handling.
Reports 11 tools
mg_get_bestsellers
Returns bestselling products based on order data with quantity and revenue totals.
mg_report_sales_summary
Aggregated sales data grouped by day, week, or month with revenue and order counts.
mg_report_sales_by_category
Sales breakdown by product category with revenue totals and product counts.
mg_report_abandoned_carts
Lists abandoned shopping carts with customer email, cart value, and items.
mg_report_customer_lifetime_value
Top customers ranked by total purchase value with order counts.
mg_report_coupon_performance
Coupon usage statistics with revenue generated and usage counts per code.
mg_report_conversion_rate
Orders divided by GA4 sessions for a date range, with a daily breakdown. Requires a GA4 property and service account connected in the portal dashboard.
mg_report_customer_retention
Splits orders in a date range between new customers (first order ever) and returning customers, with revenue and average order value for each group.
mg_report_ga4_key_events
GA4 key events (conversions) by event name for a date range, with counts. Requires GA4 connected in the portal dashboard.
mg_report_ga4_events
Top GA4 events by count for a date range, regardless of key-event status. Requires GA4 connected in the portal dashboard.
mg_report_ga4_traffic_sources
Sessions and key events broken down by acquisition channel (organic, paid, direct, referral, etc.). Requires GA4 connected in the portal dashboard.
Cache & Performance 1 tool
mg_flush_cache
Flushes or cleans Magento cache types (config, layout, block_html, etc.).
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.3.1
Indexer Management 7 tools
mg_indexer_info
Lists all indexers from the ayasoftware/magento2-mcp-api extension API.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api
mg_indexer_info_by_id
Gets details of a specific indexer by ID.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.3.1
mg_indexer_status
Lists status of all indexers (Ready, Processing, Reindex Required).
πŸ“¦ Requires: ayasoftware/magento2-mcp-api
mg_indexer_status_by_id
Gets status of a specific indexer by ID.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.3.1
mg_indexer_reindex
Reindexes all Magento indexers.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api
mg_indexer_reindex_by_id
Reindexes a specific indexer by ID.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.3.1
mg_reindex
Simplified reindex interface: reindexes all invalid indexers (no params) or specific indexers by ID array. Alias for mg_indexer_reindex but with cleaner interface.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.3.1
Reviews 6 tools
mg_list_reviews
Lists product reviews with ratings, titles, and approval status. Supports filtering and pagination.
πŸ“¦ Requires: ayasoftware/magento2-review-api
mg_get_review
Gets detailed information about a specific review by ID.
πŸ“¦ Requires: ayasoftware/magento2-review-api
mg_approve_review
Approves a pending review by ID. Changes status to "Approved" (status_id=2). Idempotent - safely handles already-approved reviews.
πŸ“¦ Requires: ayasoftware/magento2-review-api
mg_reject_review
Rejects a review by ID. Changes status to "Not Approved" (status_id=3). Idempotent - safely handles already-rejected reviews.
πŸ“¦ Requires: ayasoftware/magento2-review-api
mg_approve_reviews_batch
Batch-approves multiple reviews (max 25 per call). Returns success/failure for each review ID. Skips already-approved reviews.
πŸ“¦ Requires: ayasoftware/magento2-review-api
mg_reject_reviews_batch
Batch-rejects multiple reviews (max 25 per call). Returns success/failure for each review ID. Skips already-rejected reviews.
πŸ“¦ Requires: ayasoftware/magento2-review-api
SEO 6 tools
mg_seo_audit_product
Audits a product's SEO elements (meta title, meta description, URL key) and returns recommendations for optimization.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.2.0
mg_seo_audit_category
Audits a category's SEO elements (meta title, meta description, URL key) and returns recommendations for optimization.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.2.0
mg_detect_missing_meta_tags
Scans products or categories to detect missing or empty meta titles and descriptions. Supports filtering by category, status, and date range.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.2.0
mg_update_meta_title
Bulk-updates meta titles for products or categories (max 100 per call). Supports batch processing with error handling options.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.2.0
mg_update_meta_description
Bulk-updates meta descriptions for products or categories (max 100 per call). Supports batch processing with error handling options.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.2.0
mg_update_url_key
Bulk-updates URL keys (slugs) for products or categories (max 50 per call). Automatically creates 301 redirects from old URLs.
πŸ“¦ Requires: ayasoftware/magento2-mcp-api v1.2.0