Shopify MCP Server

Shopify MCP Server

Shopify MCP 伺服器是模組上下文協議的一種實作,專門設計用於促進 AI 應用與各種 Shopify API 之間的整合,使自動化、查詢及使用 Shopify 開發者資源和文檔變得容易。

Author: Shopify


查看協議

什麼是 Shopify MCP 伺服器?

Shopify MCP 伺服器是一個輕量級伺服器,提供一組工具和提示給基於語言模型的應用。它允許這些應用直接與 Shopify 的開發者 API 和文檔互動。透過啟動這個伺服器,你允許 AI 代理無縫地以協議標準化的方式訪問 Shopify 平台的主要功能,例如搜索文檔、探索 GraphQL API 結構和檢索入門信息。

如何配置

要設置 Shopify MCP 伺服器,你只需安裝 Node.js 和 npx。使用以下命令啟動伺服器:

npx -y @shopify/dev-mcp@latest

要將其整合到像 Cursor 或 Claude Desktop 這類 AI 應用中,添加以下配置:

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

在 Windows 上,你可以使用:

{
  "mcpServers": {
    "shopify-dev-mcp": {
      "command": "cmd",
      "args": ["/k", "npx", "-y", "@shopify/dev-mcp@latest"]
    }
  }
}

要禁用遙測,設置 OPT_OUT_INSTRUMENTATION 環境變數:

{
  "mcpServers": {
    "shopify-dev-mcp": {
      "command": "npx",
      "args": ["-y", "@shopify/dev-mcp@latest"],
      "env": {
        "OPT_OUT_INSTRUMENTATION": "true"
      }
    }
  }
}

對於實驗性的 Polaris Web 組件文檔,使用:

{
  "mcpServers": {
    "shopify-dev-mcp": {
      "command": "npx",
      "args": ["-y", "@shopify/dev-mcp@latest"],
      "env": {
        "POLARIS_UNIFIED": "true"
      }
    }
  }
}

如何使用

  1. 使用適當的 npx 命令或你的 MCP 整合啟動 Shopify MCP 伺服器。
  2. 將你的 LLM 應用(如 Cursor 或 Claude Desktop)連接到伺服器,使用提供的配置,讓其可以直接訪問 Shopify API 工具和文檔。
  3. 通過你的 AI 應用的 UI,探索可用的工具或提示,執行如搜索開發者文檔、瀏覽 Admin GraphQL 結構或直接獲取文檔等功能。
  4. 根據需要,選擇性地啟用或禁用其他功能,如 Polaris 文檔,透過環境變數進行設置。

主要特點

  • 通過標準化協議將 AI 應用與 Shopify API 和資源連接
  • 提供工具用於搜索、檢索文檔和訪問 GraphQL 結構
  • 安全的本地託管,靈活的環境變數配置
  • 支援基本和進階的開發者入門工作流程
  • 通過 MCP 可擴展,使其與各種 AI/LLM 客戶端相容
  • 可選擇性支援 Polaris Web 組件文檔(實驗性)

使用案例

  • 快速回答開發者關於 Shopify API 和用法的查詢
  • 互動式撰寫、檢視和調試 Admin GraphQL API 查詢和變更
  • 自動檢索和展示最新文檔到開發者工具或聊天機器人
  • 以直接的 AI 協助訪問參考資料和 API 指南來引導新開發者
  • 使用 LLM 將 Shopify 後端功能整合到代理工作流程或 IDE 擴展中

常見問題

Q1: 我可以將 Shopify MCP 伺服器用於 Cursor 或 Claude Desktop 之外的 AI 工具嗎?
A1: 可以。只要你的應用支援 MCP 協議,便可連接到 Shopify MCP 伺服器。

Q2: 伺服器需要什麼權限?
A2: 伺服器需要網路訪問以與 Shopify 的 API 通信,以及對任何本地資源的讀取訪問。除非添加了自定義代碼,否則不需要其他權限。

Q3: 如何更新到最新版本?
A3: 只需重新運行 npx 命令並使用 "@latest" 即可始終獲得和使用最新的包版本。

Q4: 我的數據是否會發送到 Shopify 或第三方?
A4: 伺服器默認執行有限的遙測以提高內部改善,但你可以使用 OPT_OUT_INSTRUMENTATION 環境變數禁用所有遙測。

Q5: 如何添加我自己的自定義工具或提示?
A5: 你可以使用 MCP SDK 克隆和修改源碼,然後運行你的自定義版本作為 MCP 伺服器。請參閱開發部分以獲取構建說明。