magebitcom / magento2-mcp-report-tools
magebitcom/magento2-mcp-report-tools
Report-domain MCP tools for Magebit_Mcp (admin Reports menu + admin Dashboard + statistics refresh)
Magento2 MCP - Report Tools
This is a sub-module for the Magento2 MCP module
Report-domain MCP tools for Magebit_Mcp. Exposes the admin Reports menu
(sales, tax, customer, product, review, search-term, cart, newsletter), the
admin Dashboard summary, a Customers Online live view, and the
Statistics refresh machinery — all as MCP tools.
Each read tool is a thin wrapper over the same Magento collection or service
the admin grid uses, so row counts and totals match the admin UI exactly.
Statistics refresh tools dispatch the same aggregation models as
Magento\Reports\Controller\Adminhtml\Report\Statistics\RefreshRecent /
RefreshLifetime.
Install
composer require magebitcom/magento2-mcp-report-tools
bin/magento module:enable Magebit_McpReportTools
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
Tool catalog
Shopping cart (live)
| Tool | What it does |
|---|---|
reports.cart.products |
Products currently sitting in open carts with quantities and carts count. |
reports.cart.abandoned |
Quotes that started checkout but were not converted. |
Marketing (live)
| Tool | What it does |
|---|---|
reports.marketing.search_terms |
Storefront search queries with popularity and number of matching products. |
reports.marketing.newsletter_problems |
Newsletter queue problem reports (bounces, send failures). |
Reviews (live)
| Tool | What it does |
|---|---|
reports.reviews.by_product |
Products ranked by review count with average rating. |
reports.reviews.by_customer |
Customers ranked by review count. |
Sales (aggregated)
All sales reports read from the *_aggregated_created / *_aggregated_updated
tables populated by reports.statistics.refresh_*. Arguments are shared:
from, to, period (day/month/year), store_id?, show_empty?,
order_statuses?.
| Tool | What it does |
|---|---|
reports.sales.orders |
Revenue / profit / quantity / tax / shipping / discount per period. |
reports.sales.tax |
Tax collected per rate, per period. |
reports.sales.invoiced |
Invoiced vs. paid vs. outstanding per period. |
reports.sales.shipping |
Shipping revenue per carrier / method / period. |
reports.sales.refunds |
Online and offline refunds per period. |
reports.sales.coupons |
Coupon usage and discount amount per rule / period. |
Customers
| Tool | What it does |
|---|---|
reports.customers.orders |
Order count per customer, date-ranged. |
reports.customers.totals |
Lifetime / period spend per customer. |
reports.customers.new |
Newly registered customer accounts per period. |
reports.customers.online |
Live snapshot of visitors (logged in or guest), with cart contents and last activity. |
Products
| Tool | What it does |
|---|---|
reports.products.viewed |
Most-viewed products, aggregated (daily/monthly/yearly). |
reports.products.bestsellers |
Bestselling products by quantity sold, aggregated. |
reports.products.low_stock |
Products at or below their notify-stock threshold. |
reports.products.ordered |
Quantity ordered per product within a date range. |
reports.products.downloads |
Downloadable-product link purchases and downloads. |
Dashboard
| Tool | What it does |
|---|---|
reports.dashboard.summary |
One-call roll-up that mirrors the admin Dashboard — lifetime sales, average order, revenue for a period, recent orders, top search terms, top bestsellers. |
Statistics refresh (write)
Write tools require the global magebit_mcp/general/allow_writes flag and
the token's own allow_writes flag to be 1. Both refresh tools require
explicit confirmation so MCP clients prompt before firing.
| Tool | Confirm? | What it does |
|---|---|---|
reports.statistics.status |
no (read) | Last-refresh timestamp and flag state per aggregation code. |
reports.statistics.refresh_recent |
yes | Aggregates the last 25 hours (default) for the selected report codes. Mirrors admin Refresh Statistics for Last Day. |
reports.statistics.refresh_lifetime |
yes | Aggregates all time for the selected report codes. Mirrors admin Refresh Lifetime Statistics. Heavy — on stores with 500k+ orders this can take several minutes and will elevate DB load. Run off-peak. |
Both refresh tools also implement Magebit\Mcp\Api\UnderlyingAclAwareInterface
with Magento_Reports::statistics as the underlying Magento admin resource,
so they block calls from admins who wouldn't be allowed to refresh stats in
the admin UI.
Extending
See docs/EXTENDING.md for:
- adding a new report tool that reuses the shared search-builder pattern;
- registering a new aggregation code with
AggregationRegistry(e.g. a
payment-module-specific settlement report); - adding a field resolver to enrich an existing report row.
License
Released under the MIT License.
Have questions or need help? Contact us at [email protected]
No changelog yet
The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.
Requires 3
| Package | Constraint |
|---|---|
| magebitcom/magento2-mcp-module | * |
| magento/framework | ^103.0 |
| php | >=8.1 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 30 | 30 warnings (ruleset: Magento2) — 13 auto-fixable with phpcbf |
| PHPMD | Warning | 9 | 9 rule violations (MissingImport:4, TooManyPublicMethods:2, ExcessiveClassComplexity:1, CyclomaticComplexity:1, NPathComplexity:1) |
| Cpd | Warning | 2 | 2 duplicated chunks spanning 43 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from magebitcom
View vendorModule documentation viewer for Magento 2 admin
This module enables Montonio Hirepurchase with Hyva Checkout
Google Analytics 4 MCP tools for Magebit_Mcp — wraps the GA Data and Admin APIs as MCP tools so AI clients can query property metadata, run reports, run realtime reports, and run funnel reports against your store's analytics property.
Magebit Klaviyo extension
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.