
Adobe Commerce Docs Mcp
io.github.jigarkkarangiya由 GitHub 账号 jigarkkarangiya 发布v2.0.3更新于 Oct 24, 2026
MCP server for Adobe Commerce / Magento 2 documentation — search, browse, and read official docs.
概览
让助手搜索、浏览并阅读 Adobe Experience League 上的 Adobe Commerce / Magento 2 官方文档。
- 可以做什么
- 索引 Adobe Experience League 站点地图,提供十个只读工具:带同义词扩展和模糊匹配的 BM25 排序搜索、整页 Markdown 获取、代码示例提取、页面目录、单章节获取、相关页面查找、知识库错误码查询、多查询搜索、章节列表以及站点地图刷新。还提供可浏览的 commerce:// 资源和用于排错、概念讲解、代码审查与升级的可复用提示词。结果以结构化内容和 Markdown 返回。
- 适用场景
- 适合在开发 Adobe Commerce 或 Magento 2 时,让助手引用官方文档而不是凭空回答:查询配置或 GraphQL 主题、提取代码示例、查看页面结构,或查找已知错误码。若不涉及 Adobe Commerce,则无需安装。
- 运行要求
- 以 npm 包形式通过 stdio 在本地运行(npx -y adobe-commerce-docs-mcp),需要 Node.js 18 或更高版本。索引和抓取页面需要访问 Adobe Experience League 的网络连接。可选环境变量:CACHE_DIR、EXTRA_COMMERCE_SLUGS、SITEMAP_URL。无需账号或 API 密钥。
安装
在 SourceWeft 中
- 打开 控制台中的 Adobe Commerce Docs Mcp,将其添加到工作区。
- 为需要使用其工具的对话启用该服务。
Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。
其他 MCP 客户端
参照 仓库 中的启动说明。
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
来源:README.md,提交 9fdcec5
工具
0版本历史
1- v2.0.3最新Sep 16, 2026
评分
已满足适用检查项的 40%
该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。
- 近 30 天内可连通25 分
请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。
- 已声明认证方式10 分
请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。
- 已列出工具15 分
请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。
- 描述必需15 分
- 图标10 分
- 文档15 分
- 许可证10 分
请在仓库或注册中心条目中声明许可证。