概述
安裝
工具列表
內容詳情
替代品
什麼是Magento 2 GraphQL文檔MCP服務器?
這是一個專門為Magento 2 GraphQL API文檔設計的本地搜索服務器。它能夠快速索引和搜索Adobe官方提供的350多個GraphQL文檔頁面,讓開發者無需聯網即可快速查找API文檔、代碼示例和教程。如何使用這個MCP服務器?
通過配置MCP客戶端(如Claude Desktop、VS Code等)連接到本服務器,即可在AI助手或開發工具中直接搜索Magento GraphQL文檔。支持關鍵詞搜索、分類瀏覽、代碼示例查找等多種查詢方式。適用場景
適合Magento 2開發者、API集成工程師、技術支持人員等需要快速查閱GraphQL文檔的場景。特別適用於離線開發環境、網絡受限環境,或需要頻繁查閱API文檔的工作流程。主要功能
如何使用
使用案例
常見問題
相關資源
安裝
{
"mcpServers": {
"magento-graphql-docs": {
"command": "/absolute/path/to/run-docker-mcp.sh"
}
}
}
{
"mcpServers": {
"magento-graphql-docs": {
"command": "magento-graphql-docs-mcp",
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/Users/you/projects/commerce-webapi/src/pages/graphql"
}
}
}
}
{
"mcpServers": {
"magento-graphql-docs": {
"command": "python3",
"args": ["-m", "magento_graphql_docs_mcp.server"],
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/path/to/commerce-webapi/src/pages/graphql"
}
}
}
}
{
"mcpServers": {
"magento-graphql-docs": {
"command": "magento-graphql-docs-mcp",
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/path/to/commerce-webapi/src/pages/graphql",
"MAGENTO_GRAPHQL_DOCS_DB_PATH": "/custom/databases/magento-graphql.db"
}
}
}
}
{
"mcpServers": {
"magento-graphql-docs": {
"command": "magento-graphql-docs-mcp",
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/FULL/PATH/to/commerce-webapi/src/pages/graphql"
}
}
}
}🚀 Magento 2 GraphQL文檔MCP服務器
這是一個本地的STDIO MCP服務器,可提供從本地Markdown文件中搜索和檢索Magento 2 GraphQL API文檔的工具。
📖 初次設置? 請參閱 SETUP.md 獲取分步快速入門指南。
✨ 主要特性
- 搜索文檔:對350多個GraphQL文檔頁面進行全文搜索。
- 獲取完整文檔:檢索帶有元數據的完整文檔。
- 搜索GraphQL元素:查找查詢、突變、類型和接口。
- 查看元素詳情:查看帶有示例的完整模式元素定義。
- 瀏覽分類:瀏覽文檔層次結構(模式、開發、使用、教程)。
- 訪問教程:獲取分步學習路徑(例如,結賬流程)。
- 搜索代碼示例:查找GraphQL、JSON、JavaScript中的有效代碼示例。
- 發現相關文檔:自動查找相關文檔。
- 離線操作:完全使用本地Markdown文件進行離線工作。
- 快速啟動:僅在文檔文件發生更改時重新索引(<5秒)。
🔧 技術細節
工作原理
- 解析:啟動時,服務器會解析帶有YAML前置元數據的Markdown文件。
- 提取:提取元數據、代碼塊和GraphQL模式元素。
- 索引:使用FTS5全文搜索索引將數據存儲在SQLite中。
- 搜索:提供對文檔、代碼和模式的智能搜索。
🚀 快速開始
步驟1:克隆文檔倉庫
MCP服務器需要訪問Adobe Commerce GraphQL文檔的Markdown文件。請克隆官方倉庫:
# 克隆commerce-webapi倉庫
git clone https://github.com/AdobeDocs/commerce-webapi.git
# GraphQL文檔位於:
# commerce-webapi/src/pages/graphql/
步驟2:設置文檔路徑
你可以通過以下兩種方式配置文檔路徑: 選項A:使用符號鏈接(推薦) 在項目目錄中創建符號鏈接:
cd magento-graphql-docs-mcp
ln -s /path/to/commerce-webapi/src/pages/graphql data
選項B:使用環境變量
設置 MAGENTO_GRAPHQL_DOCS_PATH 環境變量:
export MAGENTO_GRAPHQL_DOCS_PATH="/path/to/commerce-webapi/src/pages/graphql"
若要使其永久生效,請將其添加到你的shell配置文件(如 ~/.bashrc、~/.zshrc 等):
echo 'export MAGENTO_GRAPHQL_DOCS_PATH="/path/to/commerce-webapi/src/pages/graphql"' >> ~/.zshrc
source ~/.zshrc
步驟3:驗證文檔訪問權限
檢查文檔路徑是否可訪問:
# 若使用符號鏈接:
ls -la data/
# 若使用環境變量:
ls -la $MAGENTO_GRAPHQL_DOCS_PATH/
# 你應該會看到如下文件:
# - index.md
# - release-notes.md
# - schema/(目錄)
# - tutorials/(目錄)
# - develop/(目錄)
步驟4:安裝MCP服務器
cd magento-graphql-docs-mcp
pip install -e .
(可選)使用Docker構建並運行
如果你傾向於使用Docker,可以構建鏡像並將文檔路徑掛載到 /data(或者設置 MAGENTO_GRAPHQL_DOCS_PATH 到其他位置):
docker build -t magento-graphql-docs-mcp -f docker/Dockerfile .
docker run --rm -it \
-v /absolute/path/to/commerce-webapi/src/pages/graphql:/data \
magento-graphql-docs-mcp
自動獲取回退機制:如果你沒有掛載文檔,容器可以在啟動時克隆它們。可以通過 MAGENTO_GRAPHQL_DOCS_AUTO_FETCH 進行控制(默認值:true):
# 讓容器克隆文檔(使用 /tmp/commerce-webapi/src/pages/graphql)
docker run --rm -it magento-graphql-docs-mcp
# 禁用自動獲取;需要掛載路徑或預設 MAGENTO_GRAPHQL_DOCS_PATH
docker run --rm -it \
-e MAGENTO_GRAPHQL_DOCS_AUTO_FETCH=false \
-v /absolute/path/to/commerce-webapi/src/pages/graphql:/data \
magento-graphql-docs-mcp
主機端Docker包裝器(STDIO)
使用提供的包裝器來運行容器,併為MCP客戶端轉發標準輸入/輸出(不添加TTY):
# 從倉庫根目錄執行
./run-docker-mcp.sh
其功能如下:
- 如果
magento-graphql-docs-mcp鏡像缺失,會自動構建。 - 如果
MAGENTO_GRAPHQL_DOCS_PATH(或./data)存在,則將其掛載到/data;否則依賴自動獲取。 - 為MCP客戶端保持標準輸入/輸出的清潔;啟動時打印連接說明。
- 遵循
MAGENTO_GRAPHQL_DOCS_AUTO_FETCH(設置為false以要求掛載路徑)。
將你的MCP客戶端命令指向包裝器路徑。例如Claude Desktop的配置:
{
"mcpServers": {
"magento-graphql-docs": {
"command": "/absolute/path/to/run-docker-mcp.sh"
}
}
}
VS Code MCP配置
使用Docker包裝器的VS Code MCP配置示例:
{
"servers": {
"magento-webapi-docs": {
"type": "stdio",
"command": "/absolute/path/to/run-docker-mcp.sh"
}
}
}
添加服務器條目後,打開VS Code MCP/工具面板,然後為 magento-webapi-docs 點擊“啟動”以啟動基於容器的STDIO服務器。
Docker Compose(HTTP/SSE)
使用提供的 docker-compose.yml 在HTTP/SSE上運行服務器:
docker compose up --build
這將從 docker/Dockerfile 進行構建,映射 8765:8765,並設置 MAGENTO_GRAPHQL_DOCS_TRANSPORT=http 和 MAGENTO_GRAPHQL_DOCS_HOST=0.0.0.0。在 docker-compose.yml 中取消註釋 volumes 塊以綁定本地文檔檢出;否則鏡像可以自動獲取文檔。選擇端口8765是為了避免常見的8080衝突;可根據需要進行調整。
步驟5:運行並驗證
# 運行服務器(首次運行時將解析並索引350個文檔)
magento-graphql-docs-mcp
# 在另一個終端中,運行驗證測試:
python3 tests/verify_parser.py
python3 tests/verify_db.py
python3 tests/verify_server.py
📦 安裝指南
要求
- Python 3.10或更高版本。
- Git(用於克隆文檔倉庫)。
- 從 AdobeDocs/commerce-webapi 獲取的350多個Magento 2 GraphQL文檔Markdown文件。
詳細設置
1. 克隆兩個倉庫
# 克隆文檔源倉庫
git clone https://github.com/AdobeDocs/commerce-webapi.git
# 克隆此MCP服務器倉庫
cd magento-graphql-docs-mcp
2. 配置文檔路徑
服務器按以下順序查找文檔(啟動時進行路徑驗證):
- 環境變量
MAGENTO_GRAPHQL_DOCS_PATH(如果設置,驗證路徑是否存在)。 ./data/目錄(項目根目錄中的符號鏈接或包含.md文件的目錄)。../commerce-webapi/src/pages/graphql/(自動檢測兄弟目錄)。
如果未找到有效路徑,服務器將失敗,並顯示一條有用的錯誤消息,解釋所有三種設置選項。
選擇最適合你設置的方法:
# 方法1:符號鏈接(推薦用於開發)
ln -s ~/projects/commerce-webapi/src/pages/graphql data
# 方法2:環境變量(推薦用於部署)
export MAGENTO_GRAPHQL_DOCS_PATH="$HOME/projects/commerce-webapi/src/pages/graphql"
# 方法3:將commerce-webapi克隆為兄弟目錄
# magento-graphql-docs-mcp/
# commerce-webapi/
# └── src/pages/graphql/
3. 安裝依賴項
pip install -e .
這將安裝以下依賴項:
fastmcp- MCP服務器框架。sqlite-utils- 數據庫管理。pydantic- 數據驗證。python-frontmatter- YAML前置元數據解析。markdown-it-py- Markdown處理。
💻 使用示例
運行服務器
配置完成後,啟動服務器:
# 啟動MCP服務器
magento-graphql-docs-mcp
# 服務器將:
# 1. 檢查文檔是否已更改(比較文件修改時間)。
# 2. 如果需要,解析Markdown文件(350個文件,約3 - 5秒)。
# 3. 使用FTS5在SQLite中索引內容。
# 4. 開始通過STDIO監聽MCP請求。
在後續運行中,如果文檔未更改,啟動幾乎是瞬間完成(約0.87秒)。
通過HTTP/SSE運行
STDIO仍然是默認設置。若要通過帶有SSE的HTTP公開服務器(適用於期望通過SSE使用MCP的客戶端),請設置傳輸變量:
MAGENTO_GRAPHQL_DOCS_TRANSPORT=http \
MAGENTO_GRAPHQL_DOCS_HOST=0.0.0.0 \
MAGENTO_GRAPHQL_DOCS_PORT=8765 \
magento-graphql-docs-mcp
MAGENTO_GRAPHQL_DOCS_HOST 默認值為 127.0.0.1,MAGENTO_GRAPHQL_DOCS_PORT 默認值為 8765(如果未設置)。端口8765經常被其他服務使用;請選擇任何可用端口(上面的示例使用默認端口8765)。
配置
服務器使用環境變量進行配置:
文檔路徑
設置GraphQL文檔的位置:
# 選項1:絕對路徑(推薦)
export MAGENTO_GRAPHQL_DOCS_PATH="/Users/you/projects/commerce-webapi/src/pages/graphql"
# 選項2:相對路徑(從項目根目錄)
export MAGENTO_GRAPHQL_DOCS_PATH="./data"
# 選項3:相對於主目錄
export MAGENTO_GRAPHQL_DOCS_PATH="~/repos/commerce-webapi/src/pages/graphql"
默認值:服務器按以下順序查找文檔(進行驗證):
MAGENTO_GRAPHQL_DOCS_PATH環境變量(啟動時驗證)。- 項目根目錄中的
./data/目錄(必須包含.md文件)。 ../commerce-webapi/src/pages/graphql/(自動檢測兄弟目錄)。
數據庫位置
自定義SQLite數據庫的存儲位置:
# 默認值:~/.mcp/magento-graphql-docs/database.db
export MAGENTO_GRAPHQL_DOCS_DB_PATH="/custom/path/magento-graphql.db"
如果數據庫目錄不存在,將自動創建。
性能調優(可選)
自定義搜索行為和限制:
# 返回的搜索結果數量(默認值:5)
export MAGENTO_GRAPHQL_DOCS_TOP_K=10
# 每個GraphQL元素的最大字段數(默認值:20)
export MAGENTO_GRAPHQL_DOCS_MAX_FIELDS=30
# 代碼預覽的最大字符長度(默認值:400)
export MAGENTO_GRAPHQL_DOCS_CODE_PREVIEW=600
傳輸和端口
控制MCP服務器的公開方式:
MAGENTO_GRAPHQL_DOCS_TRANSPORT:stdio(默認值)或http/sse以啟用HTTP + SSE。MAGENTO_GRAPHQL_DOCS_HOST:HTTP/SSE模式的綁定地址(默認值:127.0.0.1)。MAGENTO_GRAPHQL_DOCS_PORT:HTTP/SSE端口(默認值:8765)。
當 transport="http" 時,FastMCP提供SSE服務。
與MCP客戶端一起使用
配置你的MCP客戶端(例如Claude Desktop、Cline等)以使用此服務器。
示例:Claude Desktop配置
添加到 ~/Library/Application Support/Claude/claude_desktop_config.json(macOS):
{
"mcpServers": {
"magento-graphql-docs": {
"command": "magento-graphql-docs-mcp",
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/Users/you/projects/commerce-webapi/src/pages/graphql"
}
}
}
}
示例:直接使用Python模塊
{
"mcpServers": {
"magento-graphql-docs": {
"command": "python3",
"args": ["-m", "magento_graphql_docs_mcp.server"],
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/path/to/commerce-webapi/src/pages/graphql"
}
}
}
}
示例:使用自定義數據庫路徑
{
"mcpServers": {
"magento-graphql-docs": {
"command": "magento-graphql-docs-mcp",
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/path/to/commerce-webapi/src/pages/graphql",
"MAGENTO_GRAPHQL_DOCS_DB_PATH": "/custom/databases/magento-graphql.db"
}
}
}
}
配置完成後,重啟你的MCP客戶端以激活服務器。
可用示例
examples/ 目錄包含實用的使用示例,展示了所有MCP工具:
- 產品查詢 (
examples/example_products.py)- 搜索產品文檔。
- 查找產品GraphQL查詢和類型。
- 探索ProductInterface詳情。
- 搜索產品代碼示例。
- 客戶查詢 (
examples/example_customer.py)- 搜索客戶文檔。
- 查找客戶突變(創建、更新)。
- 探索身份驗證和令牌。
- 查找客戶地址操作。
- 購物車和結賬 (
examples/example_cart_checkout.py)- 搜索購物車文檔。
- 完成結賬流程教程。
- 查找購物車突變和查詢。
- 逐步探索結賬過程。
運行示例
# 運行單個示例
python3 examples/example_products.py
python3 examples/example_customer.py
python3 examples/example_cart_checkout.py
# 或者一次性運行所有示例
bash examples/run_all_examples.sh
詳細文檔請參閱 examples/README.md。
📚 詳細文檔
MCP工具
1. search_documentation
使用關鍵字搜索文檔頁面。 參數:
queries:1 - 3個短關鍵字查詢列表(例如,["product", "cart"])。category:可選過濾器(模式、開發、使用、教程)。subcategory:可選過濾器(產品、購物車、客戶等)。content_type:可選過濾器(指南、參考、教程、模式)。 示例:
search_documentation(queries=["checkout"], category="tutorials")
2. get_document
按文件路徑獲取完整的文檔頁面。 參數:
file_path:文檔的相對路徑(例如,"schema/products/queries/products.md")。 返回值:包含元數據、前置元數據和Markdown的完整文檔內容。
3. search_graphql_elements
搜索GraphQL查詢、突變、類型或接口。 參數:
query:搜索詞。element_type:可選過濾器(查詢、突變、類型、接口、聯合)。 示例:
search_graphql_elements(query="products", element_type="query")
4. get_element_details
獲取特定GraphQL元素的完整詳細信息。 參數:
element_name:元素名稱(例如,"products"、"createCustomer")。element_type:可選類型過濾器。 返回值:包含字段、參數、源文檔和代碼示例的完整元素定義。
5. list_categories
列出所有文檔分類及其文檔數量。 返回值:顯示所有可用文檔區域的分層分類樹。
6. get_tutorial
按順序獲取包含所有步驟的完整教程。 參數:
tutorial_name:教程名稱(例如,"checkout")。 返回值:包含代碼示例和解釋的順序教程步驟。
7. search_examples
按主題和語言搜索代碼示例。 參數:
query:搜索詞。language:可選語言過濾器(graphql、json、javascript、php、bash)。 示例:
search_examples(query="add to cart", language="graphql")
8. get_related_documents
查找與指定文檔相關的文檔。 參數:
file_path:源文檔的文件路徑。 返回值:基於分類和關鍵字的相關文檔。
驗證腳本
獨立測試每個組件。 重要提示:請從項目根目錄運行所有測試:
# 導航到項目根目錄
cd magento-graphql-docs-mcp
# 測試Markdown解析器
python3 tests/verify_parser.py
# 測試數據庫攝入
python3 tests/verify_db.py
# 測試MCP服務器和所有8個工具
python3 tests/verify_server.py
# 運行性能基準測試
python3 tests/benchmark_performance.py
從其他目錄運行測試將導致導入錯誤。
數據庫架構
服務器使用SQLite,包含以下表:
- documents:所有帶有FTS5索引的文檔頁面。
- code_blocks:文檔中的代碼示例。
- graphql_elements:提取的帶有FTS5索引的GraphQL模式元素。
- metadata:攝入跟蹤。
性能
根據基準測試(運行 python3 tests/benchmark_performance.py):
- 啟動時間:0.87秒(數據未更改時)| 3 - 5秒(首次運行或文件更改時)。
- 搜索速度:平均5.5毫秒(FTS5直接查詢:0.7毫秒)。
- 文檔檢索:8.2毫秒。
- GraphQL元素搜索:3.4毫秒。
- 數據庫大小:350個文檔約30 MB。
- 索引內容:350個文檔、963個代碼塊、51個GraphQL元素。
所有性能目標均已達成:啟動時間 <5秒 ✓,搜索時間 <100毫秒 ✓。
示例查詢
| 查詢 | 工具 | 結果 |
|---|---|---|
| "如何查詢產品?" | search_documentation | 產品查詢文檔 |
| "顯示產品查詢詳情" | search_graphql_elements | 產品查詢定義 |
| "完整的結賬流程" | get_tutorial | 分步結賬指南 |
| "購物車突變示例" | search_examples | 有效的GraphQL購物車示例 |
| "所有B2B文檔" | list_categories + search | B2B模式文檔 |
開發
項目結構
magento-graphql-docs-mcp/
├── magento_graphql_docs_mcp/
│ ├── __init__.py
│ ├── config.py # 配置
│ ├── parser.py # Markdown + GraphQL解析器
│ ├── ingest.py # 數據庫攝入
│ └── server.py # 帶有8個工具的MCP服務器
├── tests/
│ ├── verify_parser.py # 解析器驗證
│ ├── verify_db.py # 數據庫驗證
│ └── verify_server.py # 服務器驗證
├── data/
│ └── (指向文檔的符號鏈接)
├── pyproject.toml
├── README.md
└── CLAUDE.md
架構
Markdown文件 (350個)
↓
解析器 (前置元數據 + 內容 + GraphQL提取)
↓
SQLite (文檔 + 代碼塊 + GraphQL元素 + FTS5)
↓
FastMCP服務器 (通過STDIO提供8個工具)
↓
MCP客戶端 (Claude、IDE等)
優勢
與網頁抓取相比
- ✅ 離線操作(無需網絡)。
- ✅ 快速啟動(3 - 5秒 vs 30 - 60秒)。
- ✅ 本地控制(可使用自定義文檔)。
- ✅ 無HTML解析複雜性。
與REST API MCP相比
- ✅ 包含教程和指南(不僅僅是API規範)。
- ✅ 代碼示例可搜索。
- ✅ 提供用於學習的敘述性內容。
- ✅ 支持教程工作流程。
獨特特性
- 📚 索引了350個文檔。
- 🔍 8個專門的搜索工具。
- 💡 支持教程。
- 📝 代碼示例搜索。
- 🔗 相關文檔發現。
- ⚡ 快速FTS5搜索。
- 🎯 支持GraphQL感知解析。
故障排除
文檔未找到錯誤
錯誤:FileNotFoundError: Documentation directory not found!
服務器現在會提供一條有用的錯誤消息,顯示所有三種設置方法。
解決方案:
- 驗證文檔倉庫是否已克隆:
git clone https://github.com/AdobeDocs/commerce-webapi.git
- 檢查路徑是否正確:
# 若使用環境變量:
echo $MAGENTO_GRAPHQL_DOCS_PATH
ls -la $MAGENTO_GRAPHQL_DOCS_PATH
# 若使用符號鏈接:
ls -la data/
# 應顯示指向GraphQL文檔的符號鏈接
# 你應該會看到350多個Markdown文件和如下目錄:
# - schema/
# - tutorials/
# - develop/
# - index.md
- 設置正確的路徑(選擇一種方法):
# 方法1:環境變量(推薦用於部署)
export MAGENTO_GRAPHQL_DOCS_PATH="/path/to/commerce-webapi/src/pages/graphql"
# 方法2:創建符號鏈接(推薦用於開發)
cd magento-graphql-docs-mcp
ln -s /path/to/commerce-webapi/src/pages/graphql data
# 驗證:ls -la data/ 應顯示符號鏈接
# 方法3:作為兄弟目錄克隆
cd parent-directory
git clone https://github.com/AdobeDocs/commerce-webapi.git
# 服務器將自動找到它
- 驗證設置:
# 服務器在啟動時會驗證路徑,並顯示有用的錯誤信息
magento-graphql-docs-mcp
# 如果路徑無效,你將看到具體嘗試了哪些方法
服務器無法啟動
錯誤:ModuleNotFoundError: No module named 'magento_graphql_docs_mcp'
解決方案:以開發模式安裝軟件包:
cd magento-graphql-docs-mcp
pip install -e .
錯誤:服務器啟動後立即退出 解決方案:檢查Python版本(需要3.10+):
python3 --version # 應為3.10或更高版本
無搜索結果
問題:即使文檔存在,搜索也沒有返回結果 解決方案:
- 使用更短、更簡單的關鍵字:
# 不要使用:"customer authentication token generation"
# 嘗試:["customer", "token"]
# 不要使用:"how to add products to cart"
# 嘗試:["cart", "add"]
- 檢查數據庫是否已創建:
ls -la ~/.mcp/magento-graphql-docs/
# 應顯示 database.db(約30 MB)
- 驗證數據是否已索引:
python3 tests/verify_db.py
# 應顯示:350個文檔、963個代碼塊、51個GraphQL元素
- 重新索引數據庫:
rm ~/.mcp/magento-graphql-docs/database.db
magento-graphql-docs-mcp # 將解析並重新索引所有內容
數據庫錯誤
錯誤:sqlite3.OperationalError: database is locked
解決方案:另一個進程正在使用數據庫:
# 查找並終止該進程
lsof ~/.mcp/magento-graphql-docs/database.db
kill <PID>
# 或者簡單地刪除並重新創建
rm ~/.mcp/magento-graphql-docs/database.db
magento-graphql-docs-mcp
錯誤:sqlite3.DatabaseError: database disk image is malformed
解決方案:數據庫已損壞,重新創建:
rm -rf ~/.mcp/magento-graphql-docs/
magento-graphql-docs-mcp # 將從頭開始重新創建
性能緩慢
問題:首次啟動需要超過10秒 解決方案:這是正常現象!首次運行會解析350個文件。後續運行時間小於1秒。 問題:每次啟動都很慢 解決方案:文檔修改時間正在更改。檢查:
# 驗證git是否未更改文件時間
cd /path/to/commerce-webapi
git status
git pull # 如果需要,更新到最新版本
驗證失敗
問題:verify_server.py 因連接錯誤而失敗
解決方案:
# 確保依賴項已安裝
pip install -e ".[dev]"
# 檢查MCP客戶端庫
pip list | grep mcp
# 重新運行單個驗證
python3 tests/verify_parser.py # 測試解析
python3 tests/verify_db.py # 測試數據庫
python3 tests/verify_server.py # 測試MCP服務器
MCP客戶端集成問題
問題:MCP客戶端顯示“未找到服務器”或“連接失敗” 解決方案:
- 驗證命令是否正確:
# 直接測試命令
which magento-graphql-docs-mcp
# 或者
python3 -m magento_graphql_docs_mcp.server
- 檢查MCP配置中的環境變量:
{
"mcpServers": {
"magento-graphql-docs": {
"command": "magento-graphql-docs-mcp",
"env": {
"MAGENTO_GRAPHQL_DOCS_PATH": "/FULL/PATH/to/commerce-webapi/src/pages/graphql"
}
}
}
}
重要提示:在MCP配置中使用絕對路徑,而不是 ~ 或相對路徑。
3. 檢查日誌:
- Claude Desktop:
~/Library/Logs/Claude/(macOS) - 查找與服務器相關的錯誤消息
獲取幫助
如果你仍然遇到問題:
- 運行所有驗證腳本:
python3 tests/verify_parser.py
python3 tests/verify_db.py
python3 tests/verify_server.py
python3 tests/benchmark_performance.py
- 檢查你的設置:
# Python版本
python3 --version
# 文檔路徑
echo $MAGENTO_GRAPHQL_DOCS_PATH
ls -la $MAGENTO_GRAPHQL_DOCS_PATH | head -20
# 數據庫
ls -la ~/.mcp/magento-graphql-docs/
# 軟件包安裝
pip show magento-graphql-docs-mcp
- 創建一個GitHub問題,並附上上述命令的輸出。
📄 許可證
本項目採用MIT許可證。
貢獻
歡迎貢獻代碼!請在提交更改之前使用驗證腳本來測試所有更改。
支持
如果你遇到問題或有疑問:
- 運行驗證腳本來診斷問題。
- 檢查數據庫位置和權限。
- 驗證文檔路徑是否正確。
替代品








