Repository navigation
getting started
tvranjes edited this page Jul 17, 2026
·
4 revisions
- PHP 8.1+
- Magento 2.4.4+
- Composer 2.2+
- An AI coding agent with MCP support (Claude Code, Cursor, GitHub Copilot, JetBrains AI, or Gemini CLI)
composer require --dev inchoo/magento-bricklayercomposer global require inchoo/magento-bricklayerAfter installation, run the install command to generate agent configuration files:
vendor/bin/bricklayer installThis generates:
-
.mcp.json— MCP server configuration for your agent -
.bricklayer.json— Per-project tool configuration - Agent-specific guideline files (
CLAUDE.md,.cursorrules, etc.)
Verify your installation is working correctly:
vendor/bin/bricklayer verifyThis checks:
- Magento root detection
- ObjectManager initialization
- Tool registration
- Configuration loading
- Log file accessibility
- Exception parser functionality
- Open your project in an AI agent that supports MCP (e.g., Claude Code)
- The MCP server starts automatically when the agent loads
- Use
search-toolsto discover available tools by keyword - Use
development-contextto load coding guidelines before writing code
You: "Show me the product catalog structure"
Agent: [calls application-info, category-tree, product-list]
You: "Create a new module for custom pricing"
Agent: [calls development-context with 'module', then generate-module]
You: "Why is the checkout failing?"
Agent: [calls diagnose-error, log with action=search]
Bricklayer auto-detects DDEV, Warden, and Docker environments. No additional configuration is needed. The bricklayer-mcp-docker wrapper handles container execution transparently.
- Configuration — Customize tool behavior
- Tools Reference — Explore all 84 tools
- Security — Understand production safety defaults
Getting Started
Architecture
Tools Reference
- Overview (84 Tools)
- Introspection
- Catalog
- Orders
- Customers
- Database
- Logs & Diagnostics
- GraphQL
- Development
Configuration
Guidelines & Skills
Code Generation
Diagnostics
Security