Shopify MCP Server

🚀 Shopify MCP Server

A Model Context Protocol (MCP) server that connects clients like Claude to your Shopify store data. This server provides tools to retrieve product and customer information from your store.

🚀 Quick Start

This Shopify MCP Server is designed to connect clients such as Claude with your Shopify store data, enabling you to retrieve product and customer information. Below is a guide to help you quickly get started.

✨ Features

• get-product-list: Retrieve a list of products from your Shopify store.
• get-customer-list: Retrieve a list of customers from your Shopify store.
• More features are coming soon.

📦 Installation

Prerequisites

• Python 3.12 or higher
• A Shopify store with API access
• Shopify API credentials (API key, password, and access token)

Steps

1. Clone the repository:

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

2. Create and activate a virtual environment using uv:

uv venv
source .venv/bin/activate  # On Unix/MacOS
# Or
.venv\Scripts\activate  # On Windows

3. Install the packages:

uv pip install -e .

📚 Documentation

Configuration

1. Create a .env file in the root directory containing your Shopify credentials:

SHOPIFY_SHOP_URL="your-store.myshopify.com"
SHOPIFY_API_KEY="your_api_key"
SHOPIFY_PASSWORD="your_api_password"
SHOPIFY_ACCESS_TOKEN="your_access_token"

Replace the placeholder values with your actual Shopify API credentials.

Usage

1. Start the MCP server:

python -m shopify_mcp_server.server

2. The server exposes two tools:

get-product-list

Retrieve a list of products from your Shopify store.

• Optional parameter: limit (default value is 10) - The maximum number of products to return.

get-customer-list

Retrieve a list of customers from your Shopify store.

• Optional parameter: limit (default value is 10) - The maximum number of customers to return.

Tool Response Formats

Products

Products (showing X):

Title: Product Name
ID: 123456789
Type: Type
Vendor: Vendor Name
Status: Active
Price: $XX.XX
---

Customers

Customers (showing X):

Name: John Doe
ID: 123456789
Email: john@example.com
Orders: X
Total Spent: $XX.XX
---

Development

This project uses:

• MCP (Model Context Protocol) for building AI-driven tools.
• Shopify Python API for Shopify integration.
• UV for dependency management.

Security

• Never commit the .env file to version control.
• Protect your Shopify API credentials.
• Use environment variables to store sensitive information.

License

This project is released under the MIT License - see the LICENSE file for details.

Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a pull request.