Shopifymockmcp

🚀 用於Shopify的MCP代理服務器和Mock Server（ShopifyMCPMockShop）

本項目實現了一個模型上下文協議（MCP）服務器，它就像一個智能橋樑和代理，能連接到Shopify的Storefront API。其獨特之處在於支持mock.shop，讓開發者無需真實商店憑證就能安全地進行開發與測試。該服務器通過**標準輸入輸出(stdio)**通信，可方便地與Claude Desktop和Cursor等客戶端進行本地集成。

🚀 快速開始

本項目實現的MCP服務器，為連接Shopify的Storefront API提供了便捷途徑，還能利用mock.shop進行安全的開發測試。以下是快速搭建和使用的步驟：

安裝步驟

1. 克隆項目倉庫：

   git clone https://github.com/yourusername/shopify-mcp-mock-server.git
   

2. 安裝依賴項：

   npm install
   

3. 啟動服務器：

   npm start
   

使用示例

基礎用法

1. 創建商店信息請求：

   const response = await fetch('http://localhost:3000', {
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
     },
     body: JSON.stringify({
       toolName: 'getShopInfo'
     })
   });
   

高級用法

2. 配置Mock環境：

   // 在項目根目錄創建 mock-config.js 文件
   module.exports = {
     shopUrl: 'mock-shop.shop',
     apiKey: 'your-mock-api-key',
     collections: [
       { id: 1, name: 'Mock Collection' },
       // 其他模擬數據...
     ]
   };
   

✨ 主要特性

核心特性

1. MCP服務器實現：作為MCP協議的代理和橋接器，支持與各種客戶端和服務集成。
2. Mock支持：通過mock.shop提供模擬環境，便於開發和測試。
3. stdio通信：使用標準輸入輸出進行通信，確保兼容性和易用性。

功能模塊

• Storefront API集成：支持與Shopify的Storefront API進行交互。
• Mock環境配置：提供模擬數據和環境設置，便於開發人員測試和驗證功能。
• 擴展插件架構：允許用戶添加自定義插件和擴展，增強服務器的功能。

📦 安裝指南

安裝步驟

1. 克隆項目倉庫：

   git clone https://github.com/yourusername/shopify-mcp-mock-server.git
   

2. 安裝依賴項：

   npm install
   

3. 啟動服務器：

   npm start
   

💻 使用示例

基礎用法

1. 創建商店信息請求：

   const response = await fetch('http://localhost:3000', {
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
     },
     body: JSON.stringify({
       toolName: 'getShopInfo'
     })
   });
   

高級用法

2. 配置Mock環境：

   // 在項目根目錄創建 mock-config.js 文件
   module.exports = {
     shopUrl: 'mock-shop.shop',
     apiKey: 'your-mock-api-key',
     collections: [
       { id: 1, name: 'Mock Collection' },
       // 其他模擬數據...
     ]
   };
   

📚 詳細文檔

相關工具

核心工具

• getShopInfo：獲取商店的基本信息（名稱、描述、貨幣）。
• findProducts：搜索/過濾產品，支持分頁和排序。
• getProductById：根據ID獲取特定產品。
• cartCreate：創建新的購物車。

擴展工具

• adminGetCustomerById：通過Admin API根據ID獲取客戶信息（計劃中）。
• adminCreateProduct：通過Admin API創建新產品（計劃中）。

測試與驗證

快速測試

1. 啟動服務器：

   npm start
   

2. 發送請求到 http://localhost:3000，例如使用Postman或curl：

   curl -X POST http://localhost:3000 \
     -H "Content-Type: application/json" \
     -d '{"toolName": "getShopInfo"}'
   

驗證結果

服務器應返回JSON格式的響應，包含工具名稱和相關數據。例如：

{
  "toolName": "getShopInfo",
  "shopName": "Mock Shop",
  "description": "A mock shop for development purposes.",
  "currencyCode": "USD"
}

擴展與計劃

計劃中的功能

1. Admin API支持：實現對Shopify Admin API的支持，包括客戶管理和產品創建。
2. 插件系統：開發一個可擴展的插件架構，允許用戶添加自定義邏輯和功能。
3. 高級模擬：提供更復雜的模擬場景，如動態數據生成和錯誤處理。

未來更新

• 支持更多Shopify API功能。
• 提供圖形化界面進行服務器配置和管理。
• 增強安全性和性能優化。

🔧 技術細節

通用AI開發者工具和現成的MCP服務器通常承諾很多，但可能缺乏透明度、安全機制（如顯式的ToolAnnotations）、穩定性或特定功能，特別是在開發環境中。本項目實現的MCP服務器，旨在解決這些問題，為用戶提供一個可靠且易於使用的解決方案。

📄 許可證

文檔未提及相關信息。

貢獻與支持

如何貢獻

1. 叉倉庫：

   git clone https://github.com/yourusername/shopify-mcp-mock-server.git
   cd shopify-mcp-mock-server
   

2. 創建功能分支：

   git checkout -b feature/new-feature
   

3. 提交更改並創建拉取請求。

獲取支持

• 郵件：support@shopify.com
• GitHub Issues：Issues 鏈接