Adobe Commerce Dev MCP

by rafaelstz

27 stars
216 downloads
Not rated
GitHub Website

About

Adobe Commerce Dev MCP is a Model Context Protocol 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.

Details

Author
rafaelstz
GitHub stars
27
Downloads
216
Categories
Other

- Search Adobe Commerce GraphQL schema for types, queries, and mutations.
- Search Adobe Commerce REST API (OpenAPI 2.0) schema for endpoints and definitions.
- Helps write GraphQL operations or REST requests with automatic API type selection.
- Validates existing GraphQL queries, REST calls, or integration snippets.
- Reports valid, deprecated, or invalid fields with corrected code suggestions.
- Supports Adobe Commerce versions 2.4.7 and 2.4.8.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Adobe Commerce Dev MCP
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Use it by configuring an MCP client (e.g., Cursor, Claude Desktop) to run the NPM package @rafaelcg/adobe-commerce-dev-mcp@latest via npx. Set the environment variable ADOBE_COMMERCE_VERSION to your store version (2.4.7 or 2.4.8). No local installation is needed.

introspect_admin_schema

This tool introspects and returns the portion of the Adobe Commerce GraphQL schema relevant to the user prompt. Only use this for the Adobe Commerce API. It takes two arguments: query and filter. The query argument is the string search term to filter schema elements by name. The filter argument is an array of strings to filter results to show specific sections.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "adobe commerce dev mcp": {
            "adobe-commerce-dev-mcp": {
                "command": "npx",
                "args": [
                    "-y",
                    "@rafaelcg/adobe-commerce-dev-mcp@latest"
                ]
            }
        }
    }
}

McpServers

{
    "adobe-commerce-dev-mcp": {
        "command": "npx",
        "args": [
            "-y",
            "@rafaelcg/adobe-commerce-dev-mcp@latest"
        ]
    }
}

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. </div>

<div align="center">
<a href="https://youtu.be/BP5Qx6hIIKc" target="_blank">
How to use Adobe Commerce Dev MCP Server
</a>
</div>

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"
      }
    }
  }
}

Install MCP Server

- Replace the server name (adobe-commerce-dev-mcp) as you wish.
- The npx command will always use the latest version of the MCP server from NPM.
- Set ADOBE_COMMERCE_VERSION to match your store (2.4.7 or 2.4.8). Defaults to 2.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"
      }
    }
  }
}

Install MCP Server

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.8 and 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.

1. npm install
2. Modify source files
3. Run npm run build to compile
4. Run npm test to run tests
5. 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.

License

ISC

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.