
Adobe Commerce Docs Mcp
io.github.jigarkkarangiyaPublished by GitHub account jigarkkarangiyav2.0.3Updated Oct 24, 2026
MCP server for Adobe Commerce / Magento 2 documentation — search, browse, and read official docs.
Overview
Lets an assistant search, browse, and read official Adobe Commerce / Magento 2 documentation from Adobe Experience League.
- What you can do
- Indexes the Adobe Experience League sitemap and exposes ten read-only tools: BM25-ranked search with synonym expansion and fuzzy matching, full-page markdown retrieval, code-example extraction, page table of contents, single-section fetch, related-page lookup, error-code lookup in the Knowledge Base, multi-query search, section listing, and sitemap refresh. It also offers browsable commerce:// resources and reusable prompts for troubleshooting, concept explanation, code review, and upgrades. Results come back as typed structured content plus markdown.
- When to use it
- Useful when working on Adobe Commerce or Magento 2 code and wanting the assistant to cite official docs instead of guessing: searching for configuration or GraphQL topics, pulling code samples, checking a page's structure, or looking up a known error code. Not needed if you do not work with Adobe Commerce.
- Requirements
- Runs locally over stdio as an npm package (npx -y adobe-commerce-docs-mcp) and needs Node.js 18 or later. Network access to Adobe Experience League is required for indexing and page fetches. Optional environment variables: CACHE_DIR, EXTRA_COMMERCE_SLUGS, SITEMAP_URL. No accounts or API keys.
Installation
In SourceWeft
- Open Adobe Commerce Docs Mcp in the dashboard and add it to a workspace.
- Enable the server for the chats that should use its tools.
Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.
Other MCP clients
Follow the launch instructions in the repository.
README
[Adobe Commerce Docs MCP logo]
Adobe Commerce Docs MCP Server
[npm version] [CI] [License: Source-Available] [Node.js]
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 programmatically - Tool annotations — all tools declare
readOnlyHint/openWorldHint/idempotentHintso MCP clients can reduce confirmation friction for safe, read-only operations - MCP Resources — browsable
commerce://URIs for sections and doc pages, capped at 300 entries per section read to stay context-safe - MCP 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+ more - Fuzzy matching — tolerates typos like
chekout→checkout,catlog→catalog - Smart 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 HTTP - Docker 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
Tools
search_adobe_commerce_docs
BM25-ranked search with synonym expansion and fuzzy matching.
get_doc_content
Fetch the full content of a documentation page as clean markdown.
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.
get_page_toc
Get the heading hierarchy (table of contents) of a page. Useful for understanding structure before fetching the full content.
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.
get_related_docs
Find sibling/related pages in the same section of the documentation tree.
lookup_error_code
Search the Knowledge Base for an error code or message. Auto-fetches the top result for immediate answers.
multi_page_search
Search with multiple queries in one call. Returns de-duplicated results — reduces round-trips when researching from multiple angles.
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:
Resources
MCP Resources let AI clients browse data directly via URIs — no tool call needed.
Prompts
MCP Prompts are reusable workflows that work across all MCP clients (Cursor, Claude Desktop, VS Code, Windsurf, etc.).
Quick Setup for Cursor
Option A: Automatic Setup Script (Linux / macOS)
Run this single command in your terminal:
Or if you have the repo cloned:
The script will:
- Check that Node.js 18+ is installed
- Create or update your
~/.cursor/mcp.json - Tell you to restart Cursor
Option B: Manual Setup (All Platforms — 3 Steps)
Prerequisites
You need Node.js 18+ installed. Check by running:
If 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:
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:
Add this JSON (if the file already has other servers, merge the adobe-commerce-docs block into the existing mcpServers object):
Restart Cursor after saving.
Setup for Other Tools
Claude Desktop
Add to your Claude Desktop config:
VS Code / GitHub Copilot
Add to .vscode/mcp.json in your project root:
Windsurf
Add to ~/.codeium/windsurf/mcp_config.json:
Usage Examples
Once connected, just ask naturally in any AI chat:
How It Works
- On 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 unavailable - Smart 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:
This starts a Streamable HTTP server on port 3000 (configurable via PORT env var).
Docker
Configuration
All settings are configurable via environment variables:
Troubleshooting
MCP server failed to start
- Verify Node.js 18+ is installed:
node --version - Test the command manually in a terminal:
- If you're behind a corporate proxy, ensure npm can reach the registry:
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
Dev Mode (auto-reload)
Run Tests
Project Structure
Contributing
- Fork the repo
- Create a branch:
git checkout -b my-feature - Make your changes
- Build and test:
npm run build && npm test - Commit and push
- Open a Pull Request
Requirements
- Node.js 18 or later
Find This MCP
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
Source: README.md at commit 9fdcec5
Tools
0Version history
1- v2.0.3LatestSep 16, 2026
Score
40% of the applicable checks met
How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.
- Reached in the last 30 days25 pts
Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.
- Auth declared10 pts
Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.
- Tools listed15 pts
Answer tools/list without a credential, or ship a package that starts in a sandbox without one.
- DescriptionRequired15 pts
- Logo10 pts
- Documentation15 pts
- License10 pts
Declare a license in the repository or the registry entry.