Access Adobe Commerce GraphQL Schema
MCP server that searches the Adobe Commerce GraphQL and REST API schemas and offers prompts to write and validate API integrations for versions 2.4.7 and 2.4.8.
1.0.0Add to Favorites
Why it matters
Streamline your Adobe Commerce development by easily accessing and querying its GraphQL schema. This tool assists in understanding your schema and writing effective GraphQL operations.
Outcomes
What it gets done
Introspect Adobe Commerce GraphQL schema
Assist in writing GraphQL operations
Query schema for data extraction
Integrate with Adobe Commerce API
Source
Get it from source
Spark does not host a copy of it.
Open sourceReports
Agent outcome reports
No reports yet
Capabilities
Tools your agent gets
Access and search the Adobe Commerce GraphQL schema
Overview
Adobe Commerce MCP Server
This MCP server interacts with Adobe Commerce. It provides tools to search the GraphQL and REST API schemas, and prompts to help write and validate API integrations. Both tools and the prompts follow the schema for the configured Adobe Commerce version. Use it when an assistant in Cursor, Claude Desktop or another MCP client needs to look up Adobe Commerce types, endpoints and arguments, write a GraphQL or REST call, or check code for invalid or deprecated fields. Set ADOBE_COMMERCE_VERSION to match your store.
What it does
This MCP server interacts with Adobe Commerce. It provides tools to search the GraphQL and REST API schemas, and prompts to help write and validate API integrations. It is used directly through its NPM package, so nothing needs to be downloaded or hosted yourself.
There are two tools, and both use the schema for the configured ADOBE_COMMERCE_VERSION:
introspect_admin_graphql_schemasearches the Adobe Commerce GraphQL schema for types, queries and mutations that match a keyword.introspect_admin_rest_schemasearches the Adobe Commerce REST API schema (OpenAPI 2.0) for endpoints and definitions that match a keyword.
There are two prompts:
adobe_commerce_apihelps write a GraphQL operation or a REST request. It takes a requiredqueryand an optionalapi_typeofgraphql,restorauto(the default). Withauto, the AI picks the best API for the use case and explains why.validate_adobe_commerce_implementationtakes a requiredcodeand an optionalcontext. It validates an existing GraphQL query, REST call or integration snippet against the configured version. It reports each type, field, argument and endpoint as valid, deprecated or invalid, and provides a corrected version of the code when needed.
When to use - and when NOT to
Use it when you write Adobe Commerce integrations and want an assistant to consult the actual schema, or when you want existing GraphQL and REST code checked for deprecated and invalid usage.
The supported versions are 2.4.7 and 2.4.8, with 2.4.8 as the default. Set ADOBE_COMMERCE_VERSION to match your store. It controls which schema files both tools load and which version the prompts reference. If the REST schema file for the configured version is not found, the server falls back to 2.4.8 and includes a note in the tool response.
The env block in the MCP config is the method for Claude Desktop, Cursor and production. In MCP Inspector, set ADOBE_COMMERCE_VERSION=2.4.7 in the Arguments field to switch schemas without restarting.
Capabilities
The server covers schema lookup by keyword for both API styles, API-choice guidance between GraphQL and REST, and validation with corrected code. You can also capture the schema of your own store: run an introspection query against your store's /graphql endpoint with an admin bearer token and save the result gzipped in the data/ folder, for example data/schema_2-4-8.json.gz. An admin token comes from a POST to /rest/V1/integration/admin/token with the admin username and password. The REST schema is fetched from /rest/all/schema?services=all with the same token and saved as data/rest_schema_2-4-8_admin.json.gz.
How to install
Configure your MCP client, such as Cursor or Claude Desktop, to run the NPM package. The npx command always uses the latest version of the server, and the server name can be changed as you wish.
{
"mcpServers": {
"adobe-commerce-dev-mcp": {
"command": "npx",
"args": ["-y", "@rafaelcg/adobe-commerce-dev-mcp@latest"],
"env": {
"ADOBE_COMMERCE_VERSION": "2.4.8"
}
}
}
}
On Windows an alternative configuration may be needed: use cmd as the command with the arguments /k, npx, -y and the package name. Cursor also offers a one-click install link.
To develop the server locally, run npm install, modify the sources, run npm run build to compile and npm test to run tests, then add an MCP server entry with the node command pointing at the built dist/index.js file. npm run inspector starts MCP Inspector. The package is ISC licensed.
Source README
Adobe Commerce Dev MCP Server
This project implements a Model Context Protocol (MCP) server that interacts with Adobe Commerce. It provides tools to search the GraphQL and REST API schemas, and prompts to help write and validate API integrations.
Usage with MCP Server via NPM Package
You can use this MCP server directly without downloading or hosting anything yourself. Simply configure your MCP client (such as Cursor or Claude Desktop) to use the NPM package:
{
"mcpServers": {
"adobe-commerce-dev-mcp": {
"command": "npx",
"args": ["-y", "@rafaelcg/adobe-commerce-dev-mcp@latest"],
"env": {
"ADOBE_COMMERCE_VERSION": "2.4.8"
}
}
}
}
- Replace the server name (
adobe-commerce-dev-mcp) as you wish. - The
npxcommand will always use the latest version of the MCP server from NPM. - Set
ADOBE_COMMERCE_VERSIONto match your store (2.4.7or2.4.8). Defaults to2.4.8. - No need to install or host anything locally or remotely.
On Windows, you might need to use this alternative configuration:
{
"mcpServers": {
"adobe-commerce-dev-mcp": {
"command": "cmd",
"args": ["/k", "npx", "-y", "@rafaelcg/adobe-commerce-dev-mcp@latest"],
"env": {
"ADOBE_COMMERCE_VERSION": "2.4.8"
}
}
}
}
Version configuration
The ADOBE_COMMERCE_VERSION setting controls which schema files are loaded by both tools and which version is referenced in prompts.
| Method | Example | When to use |
|---|---|---|
env in MCP config |
"ADOBE_COMMERCE_VERSION": "2.4.7" |
Claude Desktop, Cursor, production |
| CLI argument | ADOBE_COMMERCE_VERSION=2.4.7 in the Arguments field |
MCP Inspector |
Supported versions: 2.4.7, 2.4.8 (default).
REST schema fallback: if the REST schema file for the configured version is not found, the server falls back to
2.4.8and includes a note in the tool response.
Available tools
| Tool | Description |
|---|---|
introspect_admin_graphql_schema |
Search the Adobe Commerce GraphQL schema for types, queries, and mutations matching a keyword |
introspect_admin_rest_schema |
Search the Adobe Commerce REST API (OpenAPI 2.0) schema for endpoints and definitions matching a keyword |
Both tools use the schema for the configured ADOBE_COMMERCE_VERSION.
Available prompts
| Prompt | Parameters | Description |
|---|---|---|
adobe_commerce_api |
query (required), api_type: graphql | rest | auto (optional, default auto) |
Helps you write a GraphQL operation or REST request. When api_type is auto the AI picks the best API for the use case and explains why. |
validate_adobe_commerce_implementation |
code (required), context (optional) |
Validates an existing GraphQL query, REST call, or integration snippet against the configured Adobe Commerce version. Reports each type, field, argument, and endpoint as ✅ valid, ⚠️ deprecated, or ❌ invalid, and provides a corrected version of the code when needed. |
Getting the GraphQL schema for your local store
Run an introspection query against your local store and save the result as a gzipped file in the data/ folder:
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
Get an admin token first if needed:
curl -s -X POST https://magento.test/rest/V1/integration/admin/token \
--insecure \
-H "Content-Type: application/json" \
-d '{"username":"admin","password":"YOUR_PASSWORD"}'
Getting the REST API schema for your local store
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
Development
The server is built using the MCP SDK and communicates with Adobe Commerce.
npm install- Modify source files
- Run
npm run buildto compile - Run
npm testto run tests - Add an MCP server pointing to the built file (see below)
Local MCP config:
{
"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
Then set ADOBE_COMMERCE_VERSION=2.4.7 (or any supported version) in the Arguments field to switch schemas without restarting.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.