Adobe Commerce Docs MCP Server
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Adobe Commerce Docs MCP ServerLook up error code 500 in Adobe Commerce docs"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Adobe Commerce Docs MCP Server
An MCP (Model Context Protocol) server that gives AI assistants direct access to the official Adobe Commerce / Magento documentation. It indexes the Adobe Experience League sitemap and provides tools, resources, and prompts to search, browse, and read documentation pages — all from within your AI coding assistant.
Features
10 tools — search, read pages, browse sections, fetch one section of a long page, find related docs, extract code examples, get page TOC, lookup errors, multi-query search, and refresh
Structured tool output — every tool returns typed
structuredContent(JSON SchemaoutputSchema) alongside human-readable markdown, so clients can parse results programmaticallyTool annotations — all tools declare
readOnlyHint/openWorldHint/idempotentHintso MCP clients can reduce confirmation friction for safe, read-only operationsMCP Resources — browsable
commerce://URIs for sections and doc pages, capped at 300 entries per section read to stay context-safeMCP Prompts — reusable workflows for troubleshooting, code review, upgrades, and concept explanation
BM25 search — relevance-ranked results with IDF weighting and document-length normalization
Synonym expansion —
graphqlalso matchesgql,cloudmatchesece,modulematchesextension, and 40+ moreFuzzy matching — tolerates typos like
chekout→checkout,catlog→catalogSmart truncation — cuts at heading boundaries instead of mid-sentence
Instant cold start — indexes from a sitemap snapshot bundled with the package, then refreshes live in the background — no blocking on a live sitemap fetch to answer your first query
Persistent cache — disk cache for both sitemap (24h) and page content (7 days), survives restarts
HTTP transport —
--httpflag for remote/team deployment via Streamable HTTPDocker ready — multi-stage Dockerfile for containerized deployment
Configurable — all settings tunable via environment variables
Zero config — just add one line to your MCP config and go
Related MCP server: Magento MCP Server
Tools
search_adobe_commerce_docs
BM25-ranked search with synonym expansion and fuzzy matching.
Parameter | Type | Required | Description |
| string | Yes | Search keywords (e.g., |
| number | No | Max results to return (1–50, default: 15) |
| string | No | Filter by section slug (see Available Sections) |
get_doc_content
Fetch the full content of a documentation page as clean markdown.
Parameter | Type | Required | Description |
| string | Yes | Full URL of the doc page from search results |
get_code_examples
Extract only the code blocks from a documentation page. Returns fenced code snippets without surrounding prose — much more token-efficient than fetching the full page.
Parameter | Type | Required | Description |
| string | Yes | Full URL of the doc page |
get_page_toc
Get the heading hierarchy (table of contents) of a page. Useful for understanding structure before fetching the full content.
Parameter | Type | Required | Description |
| string | Yes | Full URL of the doc page |
get_doc_section
Fetch just one section of a page by heading name (case-insensitive, substring match), including its nested subheadings. Use this for long pages where get_doc_content's full-page fetch would truncate before reaching the section you need — check get_page_toc first to find the heading name.
Parameter | Type | Required | Description |
| string | Yes | Full URL of the doc page |
| string | Yes | Heading text to find (e.g., |
get_related_docs
Find sibling/related pages in the same section of the documentation tree.
Parameter | Type | Required | Description |
| string | Yes | Full URL of the doc page |
| number | No | Max related pages (1–30, default: 10) |
lookup_error_code
Search the Knowledge Base for an error code or message. Auto-fetches the top result for immediate answers.
Parameter | Type | Required | Description |
| string | Yes | Error code or message (e.g., |
multi_page_search
Search with multiple queries in one call. Returns de-duplicated results — reduces round-trips when researching from multiple angles.
Parameter | Type | Required | Description |
| string[] | Yes | Array of search queries (1–5) |
| number | No | Max results per query (1–20, default: 5) |
| string | No | Optional section filter for all queries |
list_doc_sections
List all available documentation sections with page counts. No parameters.
refresh_sitemap
Force-refresh the cached sitemap data, and clear the on-disk page content cache (individually cached per page for up to 7 days) so subsequently fetched pages come back fresh instead of stale. No parameters.
Available Sections
Use these slugs with the section parameter:
Section Slug | Description |
| Admin panel, catalog, customers, orders, stores configuration |
| Installation, upgrade, configuration, CLI tools, patches |
| Cloud infrastructure, deployment, environments |
| Cloud architecture, CLI/branches, CDN & Fastly VCL, dev tools & integrations |
| Live Search, Product Recommendations, Payment Services |
| Amazon Sales Channel, Channel Manager |
| Troubleshooting articles and known issues |
| Tutorials and video guides |
| Reporting and analytics |
Resources
MCP Resources let AI clients browse data directly via URIs — no tool call needed.
URI | Description |
| All documentation sections with page counts |
| Server status: version, uptime, index size |
| Browse all pages within a section (supports autocomplete) |
Prompts
MCP Prompts are reusable workflows that work across all MCP clients (Cursor, Claude Desktop, VS Code, Windsurf, etc.).
Prompt | Arguments | Description |
|
| Search Knowledge Base, provide root cause + solution + prevention |
|
| Explain a concept with code examples and best practices from official docs |
|
| Review PHP/XML/JS code against official Commerce coding standards |
|
| Generate upgrade checklist with breaking changes and rollback plan |
Quick Setup for Cursor
Option A: Automatic Setup Script (Linux / macOS)
Run this single command in your terminal:
bash <(curl -sS https://raw.githubusercontent.com/jigarkkarangiya/adobe-commerce-docs-mcp/main/setup-cursor.sh)Or if you have the repo cloned:
bash setup-cursor.shThe script will:
Check that Node.js 18+ is installed
Create or update your
~/.cursor/mcp.jsonTell you to restart Cursor
Option B: Manual Setup (All Platforms — 3 Steps)
Prerequisites
You need Node.js 18+ installed. Check by running:
node --versionIf you don't have it, install from nodejs.org.
Step 1: Open MCP Settings in Cursor
Open Cursor
Go to Settings (gear icon in bottom-left, or
Ctrl + ,/Cmd + ,)In the left sidebar, click "MCP"
Click "+ Add new MCP server"
Step 2: Add the Server
A dialog will appear. Fill it in:
Field | Value |
Name |
|
Type |
|
Command |
|
Click "Add".
Step 3: Verify
You should see adobe-commerce-docs in your MCP list with a green dot (active).
Open any chat in Agent mode and try:
"Search Adobe Commerce docs for checkout configuration"
Option C: Edit Config File Directly
Open (or create) the MCP config file:
OS | Path |
Linux |
|
macOS |
|
Windows |
|
Add this JSON (if the file already has other servers, merge the adobe-commerce-docs block into the existing mcpServers object):
{
"mcpServers": {
"adobe-commerce-docs": {
"command": "npx",
"args": ["-y", "adobe-commerce-docs-mcp"]
}
}
}Restart Cursor after saving.
Setup for Other Tools
Claude Desktop
Add to your Claude Desktop config:
OS | Config Path |
macOS |
|
Windows |
|
Linux |
|
{
"mcpServers": {
"adobe-commerce-docs": {
"command": "npx",
"args": ["-y", "adobe-commerce-docs-mcp"]
}
}
}VS Code / GitHub Copilot
Add to .vscode/mcp.json in your project root:
{
"servers": {
"adobe-commerce-docs": {
"command": "npx",
"args": ["-y", "adobe-commerce-docs-mcp"]
}
}
}Windsurf
Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"adobe-commerce-docs": {
"command": "npx",
"args": ["-y", "adobe-commerce-docs-mcp"]
}
}
}Usage Examples
Once connected, just ask naturally in any AI chat:
What You Ask | What Happens |
"Search Adobe Commerce docs for GraphQL product queries" | BM25-ranked search with synonym expansion |
"Get the documentation page for payment methods" | Fetches full page as clean markdown |
"Show me just the code examples from the DI docs" | Extracts only code blocks (saves tokens) |
"What's the table of contents for the checkout page?" | Returns heading hierarchy |
"Find related pages for this Cloud deployment doc" | Returns sibling pages in the doc tree |
"Look up error MDVA-43395" | Searches Knowledge Base, auto-fetches the top match |
"Search for REST API, GraphQL mutations, and webhooks" | Multi-query search in one call |
"What does Commerce say about catalog price rules?" | Searches, then reads the best matching page |
"Help me upgrade from 2.4.6 to 2.4.7" | Uses the upgrade-guide prompt workflow |
How It Works
┌─────────────┐ ┌──────────────────────────┐ ┌─────────────────────────┐
│ AI Client │────▶│ MCP Server (v2.0) │────▶│ Adobe Experience League │
│ (Cursor, │◀────│ │◀────│ sitemap.xml + .md pages │
│ Claude, │ │ 10 Tools │ │ │
│ VS Code) │ │ 3 Resources │ └─────────────────────────┘
│ │ │ 4 Prompts │
└─────────────┘ └──────────────────────────┘
│
├─ BM25 search with synonym expansion + fuzzy matching
├─ Pre-warms sitemap on startup
├─ Fetches .md endpoints (native markdown)
├─ Memory LRU cache: 100 pages, 1h TTL
├─ Disk page cache: 7-day TTL (survives restarts)
└─ Disk sitemap cache: 24h TTLOn startup, indexes instantly from a sitemap snapshot bundled with the package (built fresh at every npm publish), then refreshes live from Adobe Experience League in the background — search works immediately instead of blocking on a live ~77MB sitemap fetch, and self-corrects to fully live data within seconds. A valid 24h disk cache skips this and loads straight from disk.
Builds an inverted index with BM25 scoring, synonym mappings, and document frequency stats
When you search, terms are expanded with synonyms and matched with fuzzy fallback for typos
When you ask for page content, fetches the native
.mdversion (clean markdown, no HTML parsing needed)Falls back to HTML fetch + conversion if
.mdis unavailableSmart truncation cuts at heading boundaries instead of mid-sentence
Pages are cached on disk (7 days) and in memory (LRU, 100 pages, 1 hour)
HTTP Transport
For team/remote deployment, run the server in HTTP mode:
npm run start:http
# or
npx adobe-commerce-docs-mcp --httpThis starts a Streamable HTTP server on port 3000 (configurable via PORT env var).
Docker
docker build -t adobe-commerce-docs-mcp .
docker run -p 3000:3000 adobe-commerce-docs-mcpConfiguration
All settings are configurable via environment variables:
Variable | Default | Description |
| Adobe Experience League URL | Override sitemap source |
|
| Cache directory path |
|
| Sitemap cache lifetime |
|
| Max pages in memory LRU cache |
|
| Memory cache page lifetime |
|
| Disk cache page lifetime |
|
| Max characters per page response |
|
| Concurrent sitemap fetches |
|
| HTTP server port (with |
|
| Log level: debug, info, warn, error |
Troubleshooting
MCP server failed to start
Verify Node.js 18+ is installed:
node --versionTest the command manually in a terminal:
npx -y adobe-commerce-docs-mcpIf you're behind a corporate proxy, ensure npm can reach the registry:
npm config set registry https://registry.npmjs.org/
Green dot doesn't appear in Cursor
Click the refresh icon next to the server name in MCP settings
Restart Cursor completely
Check Cursor's Output panel for error messages
"No results found" for searches
The sitemap loads on first use (takes a few seconds). Wait and try again.
Use broader keywords:
"checkout"instead of"checkout multishipping step 3"Synonym expansion handles many aliases automatically (
gql→graphql,ece→cloud, etc.)Ask the AI to run
refresh_sitemapto reload the latest data
Slow first response
The first query triggers sitemap loading (~2–5 seconds). Subsequent queries are instant.
The sitemap is cached on disk for 24 hours, and page content is cached for 7 days, so restarts are fast.
Development
Run from Source
git clone https://github.com/jigarkkarangiya/adobe-commerce-docs-mcp.git
cd adobe-commerce-docs-mcp
npm install
npm run build
npm startDev Mode (auto-reload)
npm run dev # stdio transport
npm run dev:http # HTTP transportRun Tests
npm testProject Structure
adobe-commerce-docs-mcp/
├── src/
│ ├── index.ts # MCP server: tools, resources, prompts, transport
│ ├── sitemap.ts # Sitemap loading, BM25 search, synonyms, fuzzy matching
│ ├── content.ts # Page fetching, markdown/HTML parsing, structured extraction
│ └── config.ts # Environment variable configuration
├── tests/
│ ├── search.test.ts # Search, Levenshtein, synonym expansion tests
│ └── content.test.ts # Content extraction, TOC, smart truncation tests
├── dist/ # Compiled JS (generated by `npm run build`)
├── .cursor/
│ ├── rules/ # Cursor auto-apply rules for this MCP
│ └── prompts/ # Cursor slash commands (/commerce-search, etc.)
├── .github/workflows/ # CI/CD: build, test, publish
├── Dockerfile # Multi-stage Docker build for HTTP deployment
├── setup-cursor.sh # One-command Cursor setup script
├── package.json
├── tsconfig.json
├── LICENSE
└── README.mdContributing
Fork the repo
Create a branch:
git checkout -b my-featureMake your changes
Build and test:
npm run build && npm testCommit and push
Open a Pull Request
Requirements
Node.js 18 or later
Find This MCP
Registry | Link |
npm | |
GitHub | |
Official MCP Registry |
|
Cursor | cursor.directory — search |
mcp.so | mcp.so — search |
Smithery | smithery.ai — search |
Glama | glama.ai/mcp/servers — search |
Related MCPs
adobe-commerce-dev-docs-mcp— Adobe Commerce developer docs (developer.adobe.com/commerce)aem-live-docs-mcp— AEM / Edge Delivery Services docs (aem.live)adobe-app-builder-docs-mcp— Adobe App Builder — serverless, I/O Runtime, Commerce extensibilityadobe-api-mesh-docs-mcp— Adobe API Mesh — GraphQL gateway & source handlersadobe-commerce-kb-mcp— Adobe Commerce Support Knowledge Base — troubleshooting & patchesadobe-io-events-docs-mcp— Adobe I/O Events — webhooks, journaling & event providers
Changelog
See CHANGELOG.md for what's new, fixed, changed, and improved in each release.
License
Source-Available — All Rights Reserved
The source is public for transparency and evaluation. You may install and run the unmodified package for personal, educational, or internal non-commercial use. Modification, forking, redistribution, and commercial use are not permitted without prior written permission. See LICENSE for full terms.
© 2026 Jigar Karangiya · LinkedIn
This server cannot be deployed
Maintenance
Related MCP Connectors
Versioned documentation registry and semantic search for AI tools and coding assistants.
Search and read Vector Panda docs: API operations, pricing, storage tiers, measured benchmarks.
The documentation, as a tool your agent can call: 950+ AI-dev guides. Search + fetch tools.
Provide your AI coding tools with token-efficient access to up-to-date technical documentation for…
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceEnables AI assistants to search and fetch documentation content from Adobe Experience League, allowing natural language queries to retrieve Adobe product documentation and articles.-
- AlicenseBqualityCmaintenanceEnables AI assistants to manage Adobe Commerce and Magento 2 instances through business-level tools for catalog, promotions, CMS, and SEO. It features secure OAuth 1.0 authentication, safety guardrails for bulk operations, and built-in diagnostic reports for store health.38251MIT
- AlicenseAqualityBmaintenanceProvides AI assistants with direct access to Jamf official documentation, enabling them to answer Jamf-related questions by searching, retrieving articles, and browsing product documentation.62,5472MIT
- AlicenseAqualityDmaintenanceEnables AI models to search, browse, and retrieve full content of OpenCode documentation pages.375MIT