Shopifymockmcp

🚀 Shopify MCP Proxy Server and Mock Server (ShopifyMCPMockShop)

This project implements a Model Context Protocol (MCP) server that acts as an intelligent bridge and proxy, connecting to Shopify's Storefront API. Its unique feature is the support for mock.shop, enabling secure development and testing without using real store credentials.

The server communicates via standard input/output (stdio), making it suitable for local integration with clients such as Claude Desktop and Cursor.

📌 Motivation

Generic AI developer tools and off - the - shelf MCP servers often make many promises but may lack transparency, security mechanisms (such as explicit ToolAnnotations), stability, or specific features, especially in development environments. Therefore, this project aims to address these issues and provide users with a reliable and easy - to - use solution.

✨ Features and Functions

Core Features

1. MCP Server Implementation: Acts as a proxy and bridge for the MCP protocol, supporting integration with various clients and services.
2. Mock Support: Provides a mock environment through mock.shop for easy development and testing.
3. stdio Communication: Uses standard input/output for communication, ensuring compatibility and ease of use.

Functional Modules

• Storefront API Integration: Supports interaction with Shopify's Storefront API.
• Mock Environment Configuration: Provides mock data and environment settings for developers to test and validate functions.
• Extension Plugin Architecture: Allows users to add custom plugins and extensions to enhance the server's functionality.

📦 Installation and Usage

Installation Steps

1. Clone the project repository:

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

2. Install dependencies:

   npm install
   

3. Start the server:

   npm start
   

Usage Examples

Basic Usage

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

Advanced Usage

// Configure the mock environment
// Create a mock-config.js file in the project root directory
module.exports = {
  shopUrl: 'mock-shop.shop',
  apiKey: 'your-mock-api-key',
  collections: [
    { id: 1, name: 'Mock Collection' },
    // Other mock data...
  ]
};

🛠️ Related Tools

Core Tools

• getShopInfo: Get basic information about the store (name, description, currency).
• findProducts: Search/filter products, supporting pagination and sorting.
• getProductById: Get a specific product by ID.
• cartCreate: Create a new shopping cart.

Extended Tools

• adminGetCustomerById: Get customer information by ID through the Admin API (planned).
• adminCreateProduct: Create a new product through the Admin API (planned).

🧪 Testing and Verification

Quick Test

1. Start the server:

   npm start
   

2. Send a request to http://localhost:3000, for example, using Postman or curl:

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

Verify Results

The server should return a JSON - formatted response containing the tool name and relevant data. For example:

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

🚧 Expansion and Plans

Planned Features

1. Admin API Support: Implement support for the Shopify Admin API, including customer management and product creation.
2. Plugin System: Develop an extensible plugin architecture that allows users to add custom logic and functions.
3. Advanced Mocking: Provide more complex mock scenarios, such as dynamic data generation and error handling.

Future Updates

• Support more Shopify API features.
• Provide a graphical interface for server configuration and management.
• Enhance security and optimize performance.

🤝 Contribution and Support

How to Contribute

1. Fork the repository:

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

2. Create a feature branch:

   git checkout -b feature/new-feature
   

3. Commit your changes and create a pull request.

Get Support

• Email: support@shopify.com
• GitHub Issues: Issues Link