magento-mcp: Instructions file for Claude Code

CLAUDE.md

magento-mcp CLAUDE.md is an instructions file for Claude Code from FahadEjaz/magento-mcp. It costs 1,535 tokens per session, scanned A, original, MIT.

Project instructions for magento-mcp, a server that lets AI assistants work with a Magento 2 online store. Magento is an e-commerce platform; the server exposes store data through admin requests, storefront queries, and optional read-only database analysis.

In plain words
What is it for?
Use it when maintaining magento-mcp, including catalog, orders, customers, content, inventory, promotions, store settings, GraphQL queries, and read-only database analysis.
Why use it?
It explains the project's interfaces, authentication requirements, database access rules, and development commands so changes follow the repository's constraints.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is FahadEjaz/magento-mcp's own configuration. It tells Claude Code how to work on magento-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything magento-mcp configures →

Not installable: its command points at a path on the author’s own machine, so it runs nowhere else. The line is /home/fahad/.claude/plans/i-want-to-create-sorted-rain.md.

Reuse

Borrowing it

Nothing to install: this file belongs to FahadEjaz/magento-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/FahadEjaz/magento-mcp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/FahadEjaz/magento-mcp

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for magento-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/fahadejaz/magento-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/fahadejaz/magento-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/fahadejaz/magento-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/fahadejaz/magento-mcp/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for magento-mcp CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/fahadejaz/magento-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/fahadejaz/magento-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,535 This file is loaded in full into every session.
When invoked 1,535 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01535 $0.01535
Opus 5 $0.00767 $0.00767
Sonnet 5 $0.00307 $0.00307
Haiku 4.5 $0.00153 $0.00153

Measured 8d ago against content hash 8179958355c2, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

magento-mcp CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 48 lines

How it starts

The opening of the file, as written. The whole thing — 48 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this is

magento-mcp — an MCP server exposing a Magento 2 store to AI assistants via three surfaces:

  1. REST Admin API (src/magento/, src/tools/catalog.ts|orders.ts|customers.ts|cms.ts|inventory.ts|promotions.ts|store-config.ts) — authenticated via OAuth 1.0a (src/magento/oauth.ts) against a Magento Integration, not admin-user password auth
  2. GraphQL (src/graphql/, src/tools/graphql-catalog.ts) — storefront-shaped queries
  3. Direct read-only MySQL (src/db/, src/tools/db-query.ts) — analytical insight not available via REST/GraphQL; the DB connection is optionally tunneled over SSH (src/db/ssh-tunnel.ts) when MAGENTO_DB_SSH_HOST is set

Entrypoint is src/index.ts: it constructs one McpServer, calls each domain's registerXTools(server), registers the magento://store/config resource (src/resources/store-info.ts), then connects over stdio — no HTTP/SSE transport in this codebase.

Published on npm as @fahadhussain777/magento-mcp — bump version in package.json before every npm publish (npm rejects re-publishing an existing version, and a leading-zero version like 0.1.02 gets silently semver-normalized rather than rejected, so double check npm view @fahadhussain777/magento-mcp version if a publish seems to have no effect). Never publish without running npm test/npm run typecheck first (prepublishOnly does this automatically, don't remove it).

Full design rationale lives in /home/fahad/.claude/plans/i-want-to-create-sorted-rain.md (the approved implementation plan). Development phases and status are tracked in PROGRESS.md — read it first to see what's done, what's next, and known environmental gotchas (e.g. stale Docker container IPs, mkcert CA regeneration) already diagnosed for this specific setup.

Non-negotiable rules

Read the full file on GitHub · 48 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 48 lines · 1,535 tokens per session scan A 8179958355c2

Subscribe to this mod's changes

magento-mcp CLAUDE.md is an instructions file published in the GitHub repository FahadEjaz/magento-mcp (0 stars, last pushed 19d ago), licensed MIT. It adds 1,535 tokens to every session, about $0.0077 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

vibetags com-example-service-OrderService.instructions.md

Instructions for PIsberg/vibetags, covering copilot instructions for orderservice, rules for method calculatetax, rules for method processpayment, rules for method validateorder and context & focus.

PIsberg/vibetags · 553 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens