Shopify MCP Server Main

🚀 Shopify MCP 服務器

本服務器基於 MCP（模型上下文協議），用於連接不同服務和系統，可便捷地與 Shopify 店鋪進行交互，支持產品、客戶、訂單等管理操作。

🚀 快速開始

創建 Shopify 應用

1. 登錄 Shopify Partners 網站，註冊開發者賬戶。
2. 在控制檯中創建一個新的應用，填寫必要的應用信息（如名稱、描述等）。
3. 配置應用的回調 URL 和權限範圍。

克隆 MCP 服務器代碼

使用 Git 命令克隆此倉庫：

git clone https://github.com/your-username/shopify-mcp-server.git

安裝依賴項

進入項目目錄後，安裝所需的依賴包：

npm install

配置環境變量

創建一個 .env 文件，並添加以下內容：

SHOPIFY_API_KEY=your_api_key
SHOPIFY_API_SECRET=your_api_secret
PORT=3000

啟動服務器

運行以下命令啟動 MCP 服務器：

node index.js

默認情況下，服務器將在 http://localhost:3000 上運行。

✨ 主要特性

核心功能

• 產品管理：支持讀取和寫入產品的數據。
• 客戶管理：允許操作客戶的資料信息。
• 訂單處理：提供對訂單的 CRUD（創建、讀取、更新、刪除）操作。
• 收藏夾管理：管理客戶收藏的商品。
• ** webhook 集成**：訂閱或取消訂閱 Shopify 的 webhook 事件。

工具列表

以下是服務器提供的主要功能模塊及其詳細說明：

1. 獲取產品 (get-products)：

   • 輸入參數：searchTitle（用於搜索的產品標題）、limit（限制返回的產品數量）。
   • 輸出結果：包含產品 ID、標題、描述和價格等信息。

2. 創建產品 (create-product)：

   • 輸入參數包括：title（產品標題）、description（產品描述）、price（產品價格）等。
   • 返回新創建的產品 ID。

3. 更新產品 (update-product)：

   • 需要提供產品 ID 和需要修改的字段，如 newTitle 或 newDescription。

4. 刪除產品 (delete-product)：

   • 輸入參數：productId（要刪除產品的唯一標識）。
   • 返回確認信息，表示刪除成功。

5. 獲取客戶 (get-customers)：

   • 支持通過 email 過濾客戶數據，默認返回所有客戶的基本信息。

6. 創建客戶 (create-customer)：

   • 輸入參數包括：email、firstName、lastName 等。
   • 返回新客戶的唯一標識。

7. 更新客戶 (update-customer)：

   • 需要提供客戶 ID 和需要修改的字段，如 newEmail 或 newFirstName。

8. 刪除客戶 (delete-customer)：

   • 輸入參數：customerId（要刪除客戶的唯一標識）。
   • 返回確認信息，表示刪除成功。

9. 獲取訂單 (get-orders)：

   • 支持通過時間範圍或其他過濾條件篩選訂單數據。

10. 創建訂單 (create-order)：

    • 需要提供客戶 ID 和商品信息等參數。
    • 返回新生成的訂單編號。

11. 更新訂單 (update-order)：

    • 輸入參數包括：orderId（需要修改的訂單唯一標識）、newStatus（新的訂單狀態）等。

12. 刪除訂單 (delete-order)：

    • 輸入參數：orderId。
    • 返回確認信息，表示刪除成功。

13. 獲取收藏夾 (get-collections)：

    • 支持通過名稱或其他過濾條件篩選收藏夾數據。

14. 創建收藏夾 (create-collection)：

    • 需要提供收藏夾的名稱和其他相關信息。
    • 返回新創建的收藏夾 ID。

15. 更新收藏夾 (update-collection)：

    • 輸入參數包括：collectionId（需要修改的收藏夾唯一標識）、newName（新的收藏夾名稱）等。

16. 刪除收藏夾 (delete-collection)：

    • 輸入參數：collectionId。
    • 返回確認信息，表示刪除成功。

17. 訂閱 webhook (subscribe-webhook)：

    • 需要提供目標 URL 和需要訂閱的事件類型（如訂單創建、產品更新等）。
    • 返回訂閱成功的確認信息。

18. 取消訂閱 webhook (unsubscribe-webhook)：

    • 輸入參數包括：subscriptionId（需要取消的訂閱唯一標識）。
    • 返回取消成功的確認信息。

💻 使用示例

基礎用法

const request = require('request');

// 獲取產品列表
request.get('http://localhost:3000/api/products', { json: true }, (err, res, body) => {
  if (!err && res.statusCode === 200) {
    console.log(body.data);
  }
});

// 創建新客戶
const options = {
  method: 'POST',
  url: 'http://localhost:3000/api/customers',
  json: {
    email: 'test@example.com',
    firstName: 'John',
    lastName: 'Doe'
  }
};

request(options, (error, response, body) => {
  if (!error && response.statusCode === 201) {
    console.log('Customer created successfully!');
  }
});

高級用法

// 批量獲取產品
server.post('/api/products/batch', (req, res) => {
  const { products } = req.body;
  // 處理邏輯
});

// 批量刪除客戶
server.delete('/api/customers/batch', (req, res) => {
  const { customerIds } = req.body;
  // 處理邏輯
});

🔧 技術細節

數據庫選擇

服務器使用 MongoDB 作為默認數據庫，也可以通過配置支持其他存儲系統。

安全機制

• 身份驗證：所有 API 端點都需要提供有效的認證令牌。
• 速率限制：為了防止濫用，服務器內置了速率限制功能。
• 請求加密：敏感操作需要通過 HTTPS 進行加密傳輸。

事件驅動架構

基於 Node.js 的異步事件處理模型，服務器能夠高效地處理大量併發請求。

🤝 貢獻指南

如果你對該項目感興趣，歡迎加入我們的開發團隊。你可以通過以下方式貢獻代碼：

1. Fork 此倉庫。
2. 創建一個新的分支進行修改。
3. 提交併推送你的更改。
4. 提交 Pull Request 到主倉庫。

請確保你的提交遵循代碼規範，並提供詳細的文檔說明。

📄 許可證

此項目採用 MIT 許可證，具體條款見 LICENSE 文件。