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