关于 Adobe Commerce Dev MCP
Adobe Commerce Dev MCP 是一个面向 Adobe Commerce 开发的 MCP 服务,用于搜索 GraphQL 和 REST API 的 schema,并提供辅助编写与校验 API 集成代码的提示词。它通过 npm 包提供,可在 MCP 客户端中直接配置使用。
主要功能
- 01搜索 GraphQL schema 中的类型、查询和变更
- 02搜索 REST API(OpenAPI 2.0)的端点和定义
- 03按 ADOBE_COMMERCE_VERSION 加载 2.4.7 或 2.4.8 的 schema
- 04编写 GraphQL 操作或 REST 请求的提示词
- 05校验集成代码并标注有效、弃用或无效的项目
适用场景
- 01在编写 Adobe Commerce 集成代码时查找可用的 GraphQL 类型或 REST 端点
- 02校验已有的 GraphQL 查询或 REST 调用是否符合目标版本
- 03为本地商店生成并使用自定义 schema 文件
MCP 相关
该项目是 MCP 服务,向 MCP 客户端暴露两个 schema 搜索工具,并提供 adobe_commerce_api 与 validate_adobe_commerce_implementation 两个提示词。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
1收录的工具列表 · 更新于 3 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| query | string | 是 | 用于按名称筛选架构元素的搜索词。仅传入 'product'、'category' 等简单词语。 |
| filter | array | 否 | 筛选结果以显示特定部分。可包含 'types'、'queries'、'mutations' 或 'all'(默认) |
详细介绍
Adobe Commerce 开发 MCP 服务
本项目实现了一个可与 Adobe Commerce 交互的模型上下文协议(MCP)服务。它提供用于搜索 GraphQL 和 REST API 架构的工具,以及用于帮助编写和验证 API 集成的提示词。
通过 NPM 包使用 MCP 服务
无需自行下载或托管任何内容,即可直接使用此 MCP 服务。只需配置 MCP 客户端(例如 Cursor 或 Claude Desktop)以使用 NPM 包:
{
"mcpServers": {
"adobe-commerce-dev-mcp": {
"command": "npx",
"args": ["-y", "@rafaelcg/adobe-commerce-dev-mcp@latest"],
"env": {
"ADOBE_COMMERCE_VERSION": "2.4.8"
}
}
}
}
- 可根据需要替换服务名称(
adobe-commerce-dev-mcp)。 npx命令始终会从 NPM 使用最新版本的 MCP 服务。- 将
ADOBE_COMMERCE_VERSION设置为与你的商店匹配的版本(2.4.7或2.4.8)。默认值为2.4.8。 - 无需在本地或远程安装或托管任何内容。
在 Windows 上,你可能需要使用以下替代配置:
{
"mcpServers": {
"adobe-commerce-dev-mcp": {
"command": "cmd",
"args": ["/k", "npx", "-y", "@rafaelcg/adobe-commerce-dev-mcp@latest"],
"env": {
"ADOBE_COMMERCE_VERSION": "2.4.8"
}
}
}
}
版本配置
ADOBE_COMMERCE_VERSION 设置决定工具加载哪些架构文件,以及提示词中引用的版本。
| 方法 | 示例 | 适用场景 |
|---|---|---|
MCP 配置中的 env | "ADOBE_COMMERCE_VERSION": "2.4.7" | Claude Desktop、Cursor、生产环境 |
| CLI 参数 | Arguments 字段中的 ADOBE_COMMERCE_VERSION=2.4.7 | MCP Inspector |
支持的版本:2.4.7、2.4.8(默认值)。
REST 架构回退: 如果找不到所配置版本的 REST 架构文件,服务会回退到
2.4.8,并在工具响应中附带说明。
可用工具
| 工具 | 描述 |
|---|---|
introspect_admin_graphql_schema | 在 Adobe Commerce GraphQL 架构中搜索与关键词匹配的类型、查询和变更 |
introspect_admin_rest_schema | 在 Adobe Commerce REST API(OpenAPI 2.0)架构中搜索与关键词匹配的端点和定义 |
两个工具都会使用为 ADOBE_COMMERCE_VERSION 配置的架构。
可用提示词
| 提示词 | 参数 | 描述 |
|---|---|---|
adobe_commerce_api | query(必需)、api_type: graphql | rest | auto(可选,默认值为 auto) | 帮助你编写 GraphQL 操作或 REST 请求。当 api_type 为 auto 时,AI 会针对使用场景选择最合适的 API 并说明原因。 |
validate_adobe_commerce_implementation | code(必需)、context(可选) | 根据配置的 Adobe Commerce 版本验证现有 GraphQL 查询、REST 调用或集成代码片段。会将每种类型、字段、参数和端点标记为 ✅ 有效、⚠️ 已弃用或 ❌ 无效,并在需要时提供修正后的代码。 |
获取本地商店的 GraphQL 架构
针对本地商店运行内省查询,并将结果保存为 data/ 文件夹中的 gzip 压缩文件:
curl -s https://magento.test/graphql \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
--insecure \
-d '{"query":"fragment FullType on __Type { kind name description fields(includeDeprecated: true) { name description args { ...InputValue } type { ...TypeRef } isDeprecated deprecationReason } inputFields { ...InputValue } interfaces { ...TypeRef } enumValues(includeDeprecated: true) { name description isDeprecated deprecationReason } possibleTypes { ...TypeRef } } fragment InputValue on __InputValue { name description type { ...TypeRef } defaultValue } fragment TypeRef on __Type { kind name ofType { kind name ofType { kind name ofType { kind name ofType { kind name ofType { kind name ofType { kind name ofType { kind name } } } } } } } } query IntrospectionQuery { __schema { queryType { name } mutationType { name } subscriptionType { name } types { ...FullType } directives { name description locations args { ...InputValue } } } }"}' \
| gzip > data/schema_2-4-8.json.gz
如有需要,请先获取管理员令牌:
curl -s -X POST https://magento.test/rest/V1/integration/admin/token \
--insecure \
-H "Content-Type: application/json" \
-d '{"username":"admin","password":"YOUR_PASSWORD"}'
获取本地商店的 REST API 架构
curl -s "https://magento.test/rest/all/schema?services=all" \
--insecure \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
| gzip > data/rest_schema_2-4-8_admin.json.gz
开发
该服务使用 MCP SDK 构建,并与 Adobe Commerce 通信。
npm install- 修改源文件
- 运行
npm run build进行编译 - 运行
npm test运行测试 - 添加一个指向构建文件的 MCP 服务(见下文)
本地 MCP 配置:
{
"mcpServers": {
"adobe-commerce-dev-mcp": {
"command": "node",
"args": ["/absolute/path/to/adobe-commerce-dev-mcp/dist/index.js"],
"env": {
"ADOBE_COMMERCE_VERSION": "2.4.8"
}
}
}
}
MCP Inspector:
npm run inspector
然后在 Arguments 字段中设置 ADOBE_COMMERCE_VERSION=2.4.7(或任何受支持的版本),即可切换架构,无需重启。
许可证
ISC
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。