Repository navigation
Tools Development
Tools for executing PHP code, discovering tools, searching documentation, and batch operations.
Execute PHP in Magento's DI context.
| Parameter | Type | Default | Description |
|---|---|---|---|
code |
string | required | PHP code to execute |
mode |
string | execute |
execute or define
|
allow_write |
bool | false | Enable write operations |
area |
string | "" |
Area emulation context |
timeout |
int | 30 | Max execution time in seconds |
Runtime: When PsySH (psy/psysh, a bundled dependency) is installed it is used as the execution engine; otherwise a basic eval fallback runs. The response reports which one ran via a runtime field (psysh or eval).
Built-in helpers: available in both the $-prefixed scope-variable form and the bare-function form ($get(...) and get(...) are equivalent — both stay bound to the live ObjectManager across calls):
| Helper | Purpose |
|---|---|
get(Class::class) / $get(...)
|
Get singleton from DI |
create(Class::class) / $create(...)
|
Create new instance |
repo(Interface::class) / $repo(...)
|
Repository shorthand |
config('path') / $config(...)
|
Read system configuration |
query('SELECT ...') |
Execute read-only SQL |
runLog($value, 'label') |
Capture values to response |
Modes:
-
execute— Run code and return results. Read-only by default (uses transaction rollback). -
define— Save a named PHP function for reuse across calls. Max 20 per session.
Security: dangerous code patterns (shell execution, etc.) are blocked. No network access. Path traversal protection. Hard-blocked in production deploy mode — the block fails closed and cannot be lifted by config or env var, even when the deploy mode can't be read.
Returns detailed code runner documentation. No parameters.
Discover tools by keyword or group.
| Parameter | Type | Default | Description |
|---|---|---|---|
query |
string | "" |
Keyword to search |
group |
string | "" |
Filter by tool group |
detail |
string | summary |
names, summary, full
|
Use detail=names first for a lightweight overview, then detail=full for specific tools.
Search Magento documentation topics.
| Parameter | Type | Default | Description |
|---|---|---|---|
query |
string | required | Search query |
limit |
int | 10 | Max results |
Run multiple tools in a single call (max 20).
| Parameter | Type | Default | Description |
|---|---|---|---|
operations_json |
string | required | JSON array of {tool, params} objects |
Example:
[
{"tool": "product-stock-update", "params": {"sku": "SKU-001", "qty": 100}},
{"tool": "product-stock-update", "params": {"sku": "SKU-002", "qty": 50}}
]Each operation returns its own success/error status. Cannot nest batch-execute or code-runner.
Getting Started
Architecture
Tools Reference
- Overview (84 Tools)
- Introspection
- Catalog
- Orders
- Customers
- Database
- Logs & Diagnostics
- GraphQL
- Development
Configuration
Guidelines & Skills
Code Generation
Diagnostics
Security