Saleor MCP

🚀 Saleor MCP Server

A Model Context Protocol (MCP) server for Saleor Commerce that provides integration with AI assistants and tools.

🚀 Quick Start

The Saleor MCP server enables AI assistants to interact with a Saleor instance to retrieve data about products, customers, and orders. The MCP is read - only, meaning it doesn't trigger any mutations in the Saleor API.

The easiest way to test the Saleor MCP server is by visiting the production instance deployed at:

https://mcp.saleor.app/

You can connect to the server via Streamable HTTP at the https://mcp.saleor.app/mcp endpoint. Refer to the Configuration section below for details on the required headers. The production instance is configured to connect to Saleor instances hosted on the saleor.cloud domain and is compatible with Saleor 3.22.

📦 Installation

The following instructions will assist you in setting up the Saleor MCP server locally for development and testing.

Prerequisites

• Python 3.12 or higher
• uv package manager

Setup

1. Clone the repository

   git clone git@github.com:saleor/saleor-mcp.git
   cd saleor-mcp
   

2. Install dependencies

   uv sync
   

3. Run the MCP server locally

   uv run saleor-mcp
   

   The server will start at http://localhost:6000

📚 Documentation

Configuration

X-Saleor-API-URL and X-Saleor-Auth-Token headers

The Saleor MCP server uses two headers to configure the connection to the Saleor API:

• X-Saleor-API-URL: The URL of the Saleor API endpoint.
• X-Saleor-Auth-Token: The authentication token for accessing the Saleor API. The token must have MANAGE_PRODUCTS and MANAGE_ORDERS permissions to access the available tools.

Ensure that you include these headers in your requests to the MCP server.

ALLOWED_DOMAIN_PATTERN env variable

The ALLOWED_DOMAIN_PATTERN environment variable is used to specify a regex pattern for allowed API domains that the MCP server can connect to. When set, the server will validate the X-Saleor-API-URL header against this pattern. If not set, any domain is allowed. The pattern must include escaping for special characters.

Example: https:\/\/.*\.saleor\.cloud\/graphql\/ - allows any subdomain of saleor.cloud and the /graphql/ path.

Integration with AI Assistants

Saleor MCP can be enabled in AI assistants that support integration with custom MCP servers using Streamable HTTP and setting the appropriate headers.

Below is an example configuration for VSCode / Copilot using the mcp.json file:

{
  "servers": {
    "saleor-mcp": {
      "type": "http",
      "url": "https://mcp.saleor.app/mcp",
      "headers": {
        "X-Saleor-Auth-Token": "eyJhb...",
        "X-Saleor-API-URL": "https://example.saleor.cloud/graphql/"
      }
    }
  }
}

Development

This project uses ariadne-codegen to generate Saleor API client code from the GraphQL schema. See pyproject.toml for configuration. To regenerate the client locally, run:

ariadne-codegen