mage-os / module-admin-assist
mage-os/module-admin-assist
Combine the power of LLM and domain knowledge to improve admin experience though a chatbot UI.
module-admin-assistant
Introducing magento admin assistant, a powerful tool that revolutionizes admin interactions with AI capabilities.
Why module-admin-assistant?
This project revolutionizes Magento 2 admin interactions with cutting-edge AI capabilities. The core features include:
- 🚀 AI Chatbot Integration: Enhance admin experience with an intuitive chatbot UI.
- 💡 Interface Flexibility: Easily interact with agents, bots, and callbacks through defined interfaces.
- 🔍 Document Embeddings: Generate AI prompt-enhancing document embeddings effortlessly.
- 🧪 Test Set Creation: Facilitate evaluation framework testing with automated test set generation.
- 💡 Secure SQL Query Handling: Safely process and execute SQL queries with built-in safety measures.
- 🔗 Smart Link: Automatically suggest relative link and redirect users base on their questions with one click.
How to install
composer require mageos/module-admin-assist
Configuration
go to stores -> configuration -> advanced -> admin -> AI Assistant
enable this feature, select your LLM provider and put in the LLM host url and/or API credentials
run bin/magento assistant:train to load LLM with magento domain knowledge
How to use
- Click the chatbot icon on left sidebar to open the chatbot UI
- Ask questions
- Get answers
No changelog yet
The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.
Requires 2
| Package | Constraint |
|---|---|
| php | ^8.1 |
| theodo-group/llphant | ^0.9.7 |
Requires-dev 1
| Package | Constraint |
|---|---|
| phpunit/phpunit | ^9.5 |
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 | Fail | 176 | 11 errors, 165 warnings (ruleset: Magento2) — 84 auto-fixable with phpcbf |
| PHPMD | Warning | 18 | 18 rule violations (IfStatementAssignment:5, UnusedFormalParameter:4, UndefinedVariable:4, ErrorControlOperator:3, UnusedLocalVariable:2) |
| Cpd | Pass | 0 | |
| Composer validate | Pass | 0 |
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
| 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 |
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 mage-os
View vendorTurn 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.