MCP server for OpenCart — query products, orders, settings, and Journal3 theme via Claude Code or any MCP client
概览
Query and edit your OpenCart store from Claude Code. Products, orders, customers, Journal3 modules, SEO URLs, CMS pages — 42 tools, all through natural language. Built for store owners and developers who are tired of SSH + phpMyAdmin + admin panel clicking to get simple answers. It just works. You ask, Claude calls the right tool, you get the answer. 💻 Check out — same OpenCart understanding, pretty tables, sparklines, AI in the shell (opencart ask "..."), interactive REPL, live order watching. pip install opencart-cli. This matters if you're connecting AI to a live store. Every decision here was made with that in mind. - — query() only allows SELECT, SHOW, DESCRIBE, EXPLAIN - — DROP, ALTER, TRUNCATE, CREATE will never run, even through run_sql() - — database credentials stay inside the encrypted connection, never exposed - — get_file() and write_file() reject ..
README
OpenCart MCP Server
Query and edit your OpenCart store from Claude Code. Products, orders, customers, Journal3 modules, SEO URLs, CMS pages — 42 tools, all through natural language.
Built for store owners and developers who are tired of SSH + phpMyAdmin + admin panel clicking to get simple answers.
"Which products are low on stock?"
"Update the meta description for category 25"
"Show me today's orders over £50"
"Find the Journal3 module that contains our FAQ text and fix the typo"
It just works. You ask, Claude calls the right tool, you get the answer.
💻 Prefer the terminal? Check out opencart-cli — same OpenCart understanding, pretty tables, sparklines, AI in the shell (
opencart ask "..."), interactive REPL, live order watching.pip install opencart-cli.
Safe by default
This matters if you’re connecting AI to a live store. Every decision here was made with that in mind.
- Read-only queries —
query()only allows SELECT, SHOW, DESCRIBE, EXPLAIN - DDL is blocked — DROP, ALTER, TRUNCATE, CREATE will never run, even through
run_sql() - SSH tunnel — database credentials stay inside the encrypted connection, never exposed
- Path traversal blocked —
get_file()andwrite_file()reject..in paths - Access policy — optional
OPENCART_MCP_POLICY(safe/manager/developer/all) hides write tools by role; defaultallkeeps previous behavior. Levels belowallalso apply best-effort secret guardrails (blockconfig.php/ admin user tables, redact password-like settings) - Write confirmation — Claude Code prompts you before any write tool executes
- Nothing runs on your server — no agents, no daemons, no PHP files uploaded. The server runs on your machine and connects over SSH
You can point this at a production store and not worry about it doing something stupid. For day-to-day agent use on production data, prefer OPENCART_MCP_POLICY=safe or developer (writes allowed for module work, secrets still filtered) over all.
What can you actually do with it?
Store owners
- “How many orders came in this week?” → instant sales summary with daily breakdown
- “What’s running low?” → stock report sorted by quantity, lowest first
- “Update the price of product 47 to 29.99” → done, one confirmation click
- “Show me the About Us page content” → full CMS page, ready to review or edit
Developers
- “Show me the schema for oc_order” → column definitions without opening phpMyAdmin
- “List all OCMOD modifications and their status” → instant audit
- “What extensions are installed?” → full list, no admin panel needed
- “Run this SELECT against the orders table” → custom SQL with safety rails
Agencies managing multiple stores
- Run dev and live as separate MCP instances in the same Claude session
opencart_dev__get_productsvsopencart_live__get_products— no confusion- Compare stock levels, settings, or module content across environments
Journal3 users
- List, inspect, and edit J3 modules — FAQ accordions, sliders, banners, product tabs
- Read and update theme settings and skin settings per skin
- Find/replace inside module JSON — safely change text without rewriting the entire module
- J3 tools return empty results (not errors) if Journal3 isn’t installed, so the server works with any theme
How it compares
| Task | Admin panel | SSH + SQL | This MCP server |
|---|---|---|---|
| Check stock levels | Click through pages | Write a query, run it | “What’s low on stock?” |
| Update a product price | Find product, edit, save | UPDATE query by hand | “Set product 47 to £29.99” |
| Read a J3 module | JSON blob in the database | Copy-paste from phpMyAdmin | “Show me module 505” |
| Edit FAQ text | Find module, decode JSON, edit, re-encode | Pain | “Replace X with Y in module 505” |
| Sales report | Reports page, manually filter | Write aggregation queries | “Sales summary for the last 7 days” |
| Check SEO URLs | Admin > Marketing > SEO URL, paginate | SELECT from oc_seo_url | “Show SEO URLs containing ‘headphones’” |
| Manage CMS pages | Admin > Catalog > Information | Direct DB access | “Show me the About Us page” |
Quick start
1. Install
git clone https://github.com/chrisbray85/opencart-mcp.git
cd opencart-mcp
python3 -m venv .venv && source .venv/bin/activate
pip install -e .
2. Configure
cp .env.example .env
Fill in your server details:
OPENCART_SSH_HOST=your-server-ip
OPENCART_SSH_USER=your-ssh-username
OPENCART_SSH_KEY=~/.ssh/id_ed25519
OPENCART_DB_USER=your_db_user
OPENCART_DB_PASS=your_db_password
OPENCART_DB_NAME=your_opencart_database
OPENCART_ROOT=/path/to/opencart
OPENCART_STORAGE=/path/to/storage
Where to find your paths:
OPENCART_ROOT— the directory containingindex.php,admin/,catalog/,system/OPENCART_STORAGE— check yourconfig.phpfor theDIR_STORAGEvalue (often outside the web root on OpenCart 3.0.3.3+)
Optional extras:
OPENCART_SSH_PORT=22 # if SSH runs on a non-standard port
OPENCART_DB_HOST=localhost # if MySQL isn't on the same host (e.g. a tunnel)
OPENCART_DB_PREFIX=oc_ # table prefix override
OPENCART_LANGUAGE_ID=1 # skip auto-detect from config_language
# OPENCART_MCP_POLICY=all # safe | manager | developer | all (default: all)
OPENCART_MCP_POLICY controls which tools are registered:
| Value | Tools | Secret guardrails |
|---|---|---|
safe |
Read-only tools | yes |
manager |
+ catalog/order/settings/coupon writes | yes |
developer |
+ write_file, run_sql, cache/OCMOD clear |
yes |
all (default) |
Everything | no (previous behavior) |
Guardrails (when policy is not all) block paths like config.php / .env, queries against admin user/session tables, and redact password-like keys in get_settings. This is best-effort, not a hard security boundary.
Any OPENCART_DB_* value you leave unset is read from the install’s config.php automatically, so on most setups the main block above is all you need.
The storefront language is auto-detected from the store’s config_language setting, so multi-language and non-English stores work without configuration — set OPENCART_LANGUAGE_ID only to force a specific one.
No SSH? Direct MySQL mode
If your host allows remote MySQL connections (or you run your own tunnel), leave OPENCART_SSH_HOST empty and set the OPENCART_DB_* values instead:
OPENCART_SSH_HOST=
OPENCART_DB_HOST=your-mysql-host
OPENCART_DB_PORT=3306
OPENCART_DB_USER=your_db_user
OPENCART_DB_PASS=your_db_password
OPENCART_DB_NAME=your_opencart_database
OPENCART_DB_PREFIX=oc_
All SQL-backed tools work identically. File and cache tools (get_file, write_file, clear_cache, refresh_modifications) refuse to run in this mode — there’s no shell to run them on, and they must never touch a local copy of the store thinking it’s production. SSH remains the recommended transport: credentials stay inside the encrypted connection.
Using DDEV for local development?
Set OPENCART_SSH_HOST=ddev and point OPENCART_ROOT at the local project directory — commands will run via ddev exec inside your container instead of SSH:
OPENCART_SSH_HOST=ddev
OPENCART_DB_USER=db
OPENCART_DB_PASS=db
OPENCART_DB_NAME=db
OPENCART_ROOT=/Users/you/Sites/your-opencart-project
Container paths (/var/www/html etc.) are auto-resolved — you only need the local project path. (DDEV support contributed by @IceDBorn — thanks!)
3. Test the connection
source .venv/bin/activate
PYTHONPATH=src python -c "
from opencart_mcp.config import Config
from opencart_mcp.db import OpenCartDB
import json
config = Config.from_env()
db = OpenCartDB(config)
result = db.run_query('SELECT COUNT(*) as product_count FROM oc_product WHERE status = 1')
print(json.dumps(result, indent=2))
db.close()
"
You should see something like [{"product_count": "42"}]. If not, check Troubleshooting.
4. Add to Claude Code
Example prompts
These all work out of the box. Just type them into Claude Code.
Products & stock
"Show me all products with less than 5 in stock"
"Get full details for product 123 including options and images"
"Search for products with 'wireless' in the name"
"Update the price of product 47 to 34.99"
Orders & customers
"Show me today's orders"
"Get order 5892 with line items and status history"
"Find customer [email protected] — how many orders have they placed?"
"Sales summary for the last 7 days with top sellers"
SEO & content
"List all SEO URLs containing 'sale'"
"Update the SEO URL for product 23 to 'wireless-mouse-pro'"
"Show me the FAQ page content"
"Replace 'old company name' with 'new company name' in the About Us page"
Journal3 theme
"List all Journal3 FAQ modules"
"Show me the full content of module 505"
"Replace 'Free shipping over £50' with 'Free shipping over £75' in the banner module"
"What skin settings are configured for skin 1?"
Technical
"Show the schema for oc_order_product"
"List all tables matching 'journal3'"
"Run: SELECT order_id, total FROM oc_order WHERE total > 100 ORDER BY date_added DESC LIMIT 10"
"What OCMOD modifications are active?"
All 42 tools
Read (27)
| Tool | What it does |
|---|---|
get_products |
Search products with stock, prices, SEO data. Filter by category |
get_product |
Full product details — images, options, categories, attributes |
get_orders |
Recent orders filtered by status and date range |
get_order |
Full order with line items, totals, status history |
get_customers |
Search by name/email with order count and total spent |
get_categories |
Category tree with product counts and SEO URLs |
get_stock_report |
All products sorted by stock level (lowest first) |
get_settings |
OpenCart core settings by group/key |
get_j3_settings |
Journal3 theme settings |
get_j3_skin_settings |
Journal3 skin/layout settings per skin |
get_modules |
Journal3 modules by type — search content within modules |
get_j3_module |
Full module JSON data for any J3 module |
get_information_pages |
List CMS pages (About Us, FAQ, T&Cs) with content preview |
get_information_page |
Full HTML content of a single CMS/information page |
get_order_statuses |
All order status mappings with IDs |
get_product_attributes |
Product attributes (weight, storage conditions, etc.) |
sales_summary |
Revenue, top sellers, daily stats for any period |
get_modifications |
OCMOD modifications with status |
get_extensions |
Installed extensions list |
get_seo_urls |
SEO URL mappings with filtering |
query |
Custom read-only SQL (SELECT/SHOW/DESCRIBE/EXPLAIN only) |
get_table_schema |
Column definitions for any table |
list_tables |
List tables matching a pattern |
get_file |
Read files from the server (from_end for tail, optional fixed-string grep; path traversal blocked). Large logs: prefer from_end=True; with grep, only the last ~50k lines are scanned |
get_coupons |
List discount coupons with usage counts |
get_vouchers |
List gift vouchers |
dashboard |
One-call store overview — revenue, order statuses, stock alerts, latest orders |
Write (15)
| Tool | What it does |
|---|---|
update_product |
Update price, stock, name, SEO title, meta description |
update_setting |
Change OpenCart core settings |
update_j3_setting |
Change Journal3 theme settings |
update_j3_skin_setting |
Change Journal3 skin settings |
update_j3_module |
Find/replace text within J3 module JSON (banners, FAQ, sliders) |
update_information |
Find/replace text within CMS page HTML (About Us, T&Cs, etc.) |
update_seo_url |
Create or update SEO URL mappings |
update_category |
Update category name, meta, status |
write_file |
Write files to server via SFTP |
run_sql |
Execute INSERT/UPDATE/DELETE (DDL blocked) |
clear_cache |
Flush OpenCart + Journal3 caches |
refresh_modifications |
Clear OCMOD modification cache |
update_order_status |
Change order status + append order history |
create_coupon |
Create a discount coupon (percentage or fixed) |
update_coupon |
Enable/disable, extend, or edit a coupon |
How it works
Your machine Your server
┌──────────────┐ ┌──────────────┐
│ Claude Code │ │ │
│ ↓ │ SSH tunnel │ PHP cli │
│ MCP Server │ ──────────────────→ │ ↓ │
│ (Python) │ PHP via stdin │ MySQL │
│ │ ←────────────────── │ (JSON) │
└──────────────┘ └──────────────┘
The server runs on your machine. It connects to your OpenCart server via SSH, pipes PHP to the remote interpreter via stdin, and gets JSON back. Nothing is installed on your server. No files uploaded, no cleanup, no ports opened.
- PHP via stdin — works with any PHP version, nothing written to disk
- SSH tunnel — credentials never leave the encrypted connection
- Paramiko — pure Python SSH, no system dependencies beyond Python 3.10+
- Direct MySQL —
pymysqlfallback for hosts without SSH (file/cache tools disabled)
Multiple stores
Run dev and live as separate instances in the same Claude session:
{
"mcpServers": {
"opencart_dev": {
"command": "/path/to/opencart-mcp/.venv/bin/python",
"args": ["-m", "opencart_mcp.server"],
"cwd": "/path/to/opencart-mcp",
"env": { "OPENCART_DB_NAME": "my_dev_database", "..." }
},
"opencart_live": {
"command": "/path/to/opencart-mcp/.venv/bin/python",
"args": ["-m", "opencart_mcp.server"],
"cwd": "/path/to/opencart-mcp",
"env": { "OPENCART_DB_NAME": "my_live_database", "..." }
}
}
}
Claude prefixes tools automatically — opencart_dev__get_products vs opencart_live__get_products — so there’s no confusion about which store you’re querying.
You can also run the same store twice with different policies (e.g. daily safe plus an occasional developer entry) by duplicating the block and setting OPENCART_MCP_POLICY per instance.
Tested with
| Component | Versions |
|---|---|
| OpenCart | 3.0.3.2 — 3.0.5.0 (any 3.x should work) |
| PHP | 5.6+ (server-side) |
| Python | 3.10+ (local machine) |
| Journal3 | 3.x (optional — everything works without it) |
| OpenCart forks | ocStore / LiveStore 3.x (SQL-compatible; for Technics-theme tools see the livestore-mcp fork) |
| Hosting | VPS, dedicated servers, shared hosting with SSH or remote MySQL |
| Clients | Claude Code CLI, VS Code extension, JetBrains extension |
Used daily on production stores with 100+ products, thousands of orders, and Journal3 theme.
Troubleshooting
SSH connection fails
# Test SSH works
ssh your-user@your-server "echo ok"
# Test PHP is available
ssh your-user@your-server "echo '<?php echo 1;' | php"
If SSH needs a password instead of a key:
ssh-copy-id -i ~/.ssh/id_ed25519.pub your-user@your-server
Empty results
- Run the test script to check credentials
OPENCART_ROOTshould point to the directory containingindex.phpOPENCART_STORAGEshould matchDIR_STORAGEin yourconfig.php
cPanel / shared hosting
cPanel prints tput: No value for $TERM warnings over SSH. The server filters these automatically.
Slow queries
Default timeout is 30 seconds. If queries are slow, check if SSH goes through a VPN (adds latency) or if the server is under load.
Journal3 tables not found
Normal if you’re not running Journal3. The J3 tools return empty results instead of errors.
Common path issues
| Hosting | Typical OPENCART_ROOT | Typical OPENCART_STORAGE |
|---|---|---|
| cPanel | /home/user/public_html |
/home/user/oc_storage |
| Plesk | /var/www/vhosts/domain/httpdocs |
Above web root |
| Custom VPS | /var/www/html or /var/www/opencart |
Varies |
Check your config.php — both DIR_APPLICATION and DIR_STORAGE are defined there.
Roadmap
- [ ] OpenCart 4.x support
- [x] Direct MySQL transport + language auto-detection (v0.7.0)
- [x] Coupon and voucher management tools (v0.6.0)
- [x] Order status update tool (v0.6.0)
- [ ] Bulk product import/export
- [ ] Customer group management
- [x] Dashboard summary tool (one prompt, full store overview) (v0.6.0)
Got a feature request? Open an issue.
Changelog
See releases for full history.
0.7.0
- Direct MySQL transport (pymysql) when
OPENCART_SSH_HOSTis empty — file/cache tools refuse in this mode - Storefront
language_idauto-detected fromconfig_language(override withOPENCART_LANGUAGE_ID) — fixes hardcodedlanguage_id = 1on non-English stores - Revenue queries now also exclude canceled-reversal, chargeback, and voided orders
- First unit tests (
tests/test_config.py)
Contributing
Issues and PRs welcome. If you’re running this on a hosting setup or OpenCart version not listed above, let us know what works and what doesn’t.
Thanks to the contributors so far:
- @IceDBorn — DDEV support and the Nix flake
- @ClayRabbit — configurable SSH port and full
config.phpDB fallback - @Penikov — direct MySQL transport and language auto-detection; maintains the livestore-mcp fork for LiveStore + Technics stores
Support
Built and maintained in evenings. If it saves you time on a store, a coffee helps keep the tools coming:
License
MIT — see LICENSE for details.
安装
This server does not publish a one-line install command.
Open the repository installation guide配置
{
"mcpServers": {
"opencart": {
"command": "/absolute/path/to/opencart-mcp/.venv/bin/python",
"args": ["-m", "opencart_mcp.server"],
"cwd": "/absolute/path/to/opencart-mcp",
"env": {
"PYTHONPATH": "/absolute/path/to/opencart-mcp/src",
"OPENCART_SSH_HOST": "your-server-ip",
"OPENCART_SSH_USER": "your-ssh-username",
"OPENCART_SSH_KEY": "~/.ssh/id_ed25519",
"OPENCART_DB_USER": "your_db_user",
"OPENCART_DB_PASS": "your_db_password",
"OPENCART_DB_NAME": "your_opencart_database",
"OPENCART_ROOT": "/path/to/opencart",
"OPENCART_STORAGE": "/path/to/storage"
}
}
}
}