Magento 2 GraphQL文档搜索工具是 florinel-chis 开发的 MCP 服务器:一个本地STDIO MCP服务器,提供从本地Markdown文件中搜索和检索Magento 2 GraphQL API文。接入两步走:git clone https://github.com/AdobeDocs/commerce-webapi.git,再把下文配置粘进客户端 mcpServers 段重启即可。
它是干什么的
先把话说清楚:Magento 2 GraphQL文档搜索工具不是又一个大模型,而是一个标准的 MCP 服务器。装好之后,你的 AI 客户端多出一组新工具,模型可以按需调用。一个本地STDIO MCP服务器,提供从本地Markdown文件中搜索和检索Magento 2 GraphQL API文档的工具,适用于开发者在离线环境下快速查询API文档、代码示
| 项目 | 数据 |
|---|---|
| 开发者 | florinel-chis |
| Star | 9 |
| 收藏 | 0 |
| 质量等级 | C |
| 平台分类 | 开发效率 |
| 部署标签 | 本地部署、文档搜索、GraphQL |
| 仓库 | magento-graphql-docs-mcp |
核心能力
- Search Documentation: Full-text search across 350+ GraphQL documentation pages
- Get Complete Documents: Retrieve full documentation with metadata
- Search GraphQL Elements: Find queries, mutations, types, and interfaces
- Get Element Details: View complete schema element definitions with examples
- Browse Categories: Navigate documentation hierarchy (schema, develop, usage, tutorials)
- Access Tutorials: Get step-by-step learning paths (e.g., checkout workflow)
- Search Code Examples: Find working code examples in GraphQL, JSON, JavaScript
- Discover Related Docs: Find related documentation automatically
适合谁用
两类人最该装:一是天天在 Claude Desktop、Cursor 里写代码,想让 AI 直接帮你跑命令、改仓库、读文件的人;二是已经在用 MCP 生态、想按需拼装能力的折腾型用户。反过来,如果你只需要偶尔手动用它背后的服务,直接开网页就行,不必上 MCP。
完整安装配置步骤
动手前确认环境齐了:
- Python 3.10+ 与 pip(个别仓库要求 3.11+,以 README 为准)。
- Docker 环境(
docker ps正常返回即可)。 - git。
- 一个支持 MCP 的客户端:Claude Desktop、Cursor、Cline、Windsurf 任选其一。
第 1 步:安装Magento 2 GraphQL文档搜索工具
终端里任选一条(不同安装方式,效果等价):
git clone https://github.com/AdobeDocs/commerce-webapi.git
pip install -e .
docker build -t magento-graphql-docs-mcp -f docker/Dockerfile .
docker run --rm -it \第 2 步:按官方说明写入配置
Magento 2 GraphQL文档搜索工具的 README 没给标准 mcpServers JSON,配置入口见 官方文档 的 Usage/Configuration 章节。原则不变:客户端配置文件里加 mcpServers 条目,重启生效。
第 3 步:重启并验证
完全退出客户端再打开(是托盘里真正退出,不是关窗口)。工具列表里出现Magento 2 GraphQL文档搜索工具的工具即接入成功;调用报错的话,先查下面的坑点清单。
容易踩的坑
- 改了配置没反应:客户端只重启了窗口没退进程。macOS 按 Cmd+Q,Windows 检查托盘。
- JSON 报错打不开客户端:多半是最后多个逗号。粘进任何 JSON 校验器里查一遍再保存。
常见问题
Magento 2 GraphQL文档搜索工具免费吗?
代码在 GitHub(https://github.com/florinel-chis/magento-graphql-docs-mcp)开放获取。个别功能依赖第三方服务时费用另算,看仓库 LICENSE 和定价页。
Magento 2 GraphQL文档搜索工具能用在 Cursor / Cline 吗?
能。MCP 是通用协议,同一份 mcpServers 配置在这些客户端之间基本通用,只是配置文件位置不同。
需要外网或代理吗?
拉包和调用官方 API 需要能访问 GitHub 与对应服务域名,内网环境先测 git ls-remote 和接口连通性。
