someplus / module-mage-assist-smart-query
MageAssist - AI-powered admin assistant for Adobe Commerce with OpenAI, Claude, and OpenRouter support
MageAssist - AI Admin Assistant for Magento 2 / Adobe Commerce
MageAssist is an AI-powered assistant for your Magento 2 admin panel. Query orders, customers, products, and generate reports using natural language.
Features
Multi-Provider AI Support
- OpenAI - GPT-4o, GPT-4, GPT-3.5 + Custom Models
- Anthropic Claude - Claude 3.5 Sonnet, Claude 3 Opus + Custom Models
- OpenRouter - Access to 100+ AI models + Custom Models
Query Capabilities
- Orders: Search, filter, view details, status distribution
- Customers: Lookup, order history, statistics
- Products: Search, stock levels, low stock alerts
- Reports: Sales reports, revenue trends, top products
Visual Analytics
- Interactive charts powered by Chart.js
- Line, bar, pie, and doughnut charts
- Revenue trends, order distributions, product performance
User Experience
- Floating chat widget on all admin pages
- Fullscreen mode for detailed analysis
- Chat history per admin user
- Quick action buttons for common queries
Requirements
- Magento 2.4.4 or higher / Adobe Commerce 2.4.4+
- PHP 8.1 or higher
- API key from OpenAI, Anthropic, or OpenRouter
Installation
Via Composer (Recommended)
composer require someplus/module-mage-assist-smart-query
bin/magento module:enable SomePlus_AdminChatbot
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean
Manual Installation
- Create directory:
app/code/SomePlus/AdminChatbot - Extract package contents to that directory
- Run Magento commands:
bin/magento module:enable SomePlus_AdminChatbot
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean
Configuration
- Go to Stores > Configuration > SomePlus > MageAssist
- Select your AI Provider (OpenAI, Anthropic, or OpenRouter)
- Enter your API key
- Choose your preferred model (or use Custom Model option)
- Configure advanced settings if needed
- Save configuration
Usage
Basic Queries
Ask questions in natural language:
- "How many orders came in today?"
- "Show me pending orders"
- "Find customer [email protected]"
- "What's the stock for SKU-123?"
- "Give me this week's sales report"
Report Queries
For visual reports:
- "Show revenue trend for the last month"
- "What are the top selling products?"
- "Show order status distribution"
- "Customer statistics for this week"
Quick Actions
Use the quick action buttons for common tasks:
- Today's Orders
- Weekly Report
- Low Stock Products
- New Customers
API Providers
OpenAI
Get your API key from OpenAI Platform
Recommended models:
- gpt-4o - Best performance (recommended)
- gpt-4o-mini - Faster and cheaper
Anthropic Claude
Get your API key from Anthropic Console
Recommended models:
- claude-3-5-sonnet - Best balance
- claude-3-opus - Most capable
OpenRouter
Get your API key from OpenRouter
Access to multiple providers through one API.
Custom Models
All providers support custom model names. Select "Custom Model" from the dropdown and enter any valid model identifier.
Security
- All API keys are encrypted in the database
- READ-ONLY access to store data
- No data modification capabilities
- Admin ACL resource controls
- Rate limiting per user
Support
- Documentation: https://docs.someplus.work/mageassist
- Support: [email protected]
- Issues: https://github.com/someplus/mageassist/issues
Changelog
See CHANGELOG.md for version history.
License
Commercial License - See LICENSE.txt
Copyright (c) 2024 SomePlus
Changelog - MageAssist
All notable changes to MageAssist will be documented in this file.
The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.
[1.0.2] - 2026-04-26
Changed
- Composer package name:
someplus/module-mage-assist-smart-query(avoids duplicate Marketplace SKU; differs only by a hyphen:mage-assist)
[1.0.1] - 2026-04-26
Changed
- Product renamed to "Mage Assist – Smart Query"
- Version bump to 1.0.1 for Adobe Commerce Marketplace (resolves duplicate 1.0.0)
Fixed
- PHP 8.4 compatibility added to composer.json
- Replaced md5() with sha256 hash for improved security
[1.0.0] - 2024-11-25
Added
- Initial release of MageAssist
- Multi-provider AI support (OpenAI, Anthropic Claude, OpenRouter)
- Custom model name support for all providers
- Order queries: search, filter by status/date/customer, view details
- Customer queries: lookup by email/ID/name, order history, statistics
- Product queries: search by name/SKU, stock information
- Inventory management: low stock alerts, stock levels
- Sales reporting: daily/weekly/monthly reports, revenue trends
- Chart.js integration for visual analytics
- Line, bar, pie, and doughnut chart support
- Floating chat widget for admin panel
- Fullscreen mode
- Chat history per admin user
- Quick action buttons
- Rate limiting
- Admin ACL integration
- Encrypted API key storage
- Multi-language support (English default)
Security
- Read-only data access
- CSRF token validation
- Admin session validation
- Rate limiting per user (configurable)
- Encrypted API credentials
[Unreleased]
Planned
- Webhook notifications
- Custom function definitions
- Export chat history
- Voice input support
- Additional chart types
- Custom report templates
Requires 8
| Package | Constraint |
|---|---|
| magento/framework | 103.0.*||104.0.* |
| magento/module-backend | 102.0.* |
| magento/module-catalog | 104.0.* |
| magento/module-catalog-inventory | 100.4.* |
| magento/module-customer | 103.0.* |
| magento/module-sales | 103.0.* |
| magento/module-store | 101.1.* |
| 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 | 92 | 92 warnings (ruleset: Magento2), 51 auto-fixable with phpcbf |
| PHPMD | Warning | 49 | 49 rule violations (UnusedPrivateField:49) |
| Cpd | Warning | 1 | 1 duplicated chunk spanning 75 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.
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 Some Plus
View vendorContent reactions (emoji) module for Magento 2 CMS pages
Magento 2 Free Shipping Progress Bar - Motivate customers to reach free shipping threshold with a dynamic progress bar displayed in header, mini cart, cart page, and checkout.
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.