saleor-mcp

🚀 Saleor MCP Server

Saleor MCP Server 是一个适用于 Saleor Commerce 的模型上下文协议（MCP）服务器，可实现与 AI 助手及工具的集成。它能让 AI 助手与 Saleor 实例交互，获取产品、客户和订单等数据，且不会触发 Saleor API 的任何变更。

🚀 快速开始

Saleor MCP 服务器允许 AI 助手与 Saleor 实例进行交互，以获取有关产品、客户和订单的数据。该 MCP 是只读的，不会触发 Saleor API 中的任何变更。

尝试 Saleor MCP 服务器的最简单方法是访问部署的生产实例：

https://mcp.saleor.app/

你可以通过 Streamable HTTP 在 https://mcp.saleor.app/mcp 端点连接到服务器。有关所需请求头的详细信息，请参阅下面的“配置”部分。生产实例配置为连接到托管在 saleor.cloud 域上的 Saleor 实例，并且与 Saleor 3.22 兼容。

📦 安装指南

以下说明将帮助你在本地设置 Saleor MCP 服务器，用于开发和测试。

前提条件

• Python 3.12 或更高版本
• uv 包管理器

设置步骤

1. 克隆仓库

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

2. 安装依赖项

uv sync

3. 在本地运行 MCP 服务器

uv run saleor-mcp

服务器将在 http://localhost:6000 启动。

📚 详细文档

配置

X-Saleor-API-URL 和 X-Saleor-Auth-Token 请求头

Saleor MCP 服务器使用两个请求头来配置与 Saleor API 的连接：

• X-Saleor-API-URL - Saleor API 端点的 URL。
• X-Saleor-Auth-Token - 用于访问 Saleor API 的身份验证令牌。该令牌必须具有 MANAGE_PRODUCTS 和 MANAGE_ORDERS 权限才能访问可用工具。

请确保在向 MCP 服务器发出的请求中包含这些请求头。

ALLOWED_DOMAIN_PATTERN 环境变量

ALLOWED_DOMAIN_PATTERN 环境变量用于指定 MCP 服务器可以连接的允许 API 域的正则表达式模式。设置后，服务器将根据此模式验证 X-Saleor-API-URL 请求头。如果未设置，则允许任何域。模式必须对特殊字符进行转义。

示例：https:\/\/.*\.saleor\.cloud\/graphql\/ - 允许 saleor.cloud 的任何子域和 /graphql/ 路径。

与 AI 助手集成

Saleor MCP 可以在支持使用 Streamable HTTP 与自定义 MCP 服务器集成的 AI 助手中启用，并设置适当的请求头。

以下是使用 mcp.json 文件为 VSCode / Copilot 配置的示例：

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

开发

本项目使用 ariadne-codegen 从 GraphQL 模式生成 Saleor API 客户端代码。有关配置，请参阅 pyproject.toml。 要在本地重新生成客户端，请运行：

ariadne-codegen