MCP 服务器

BigCommerce API MCP Server

Enables AI assistants to interact with BigCommerce stores through comprehensive REST API integration. Provides tools for managing products, customers, and orders with advanced filtering and relationship tracking capabilities.

README

BigCommerce MCP Server

A comprehensive Model Context Protocol (MCP) server for BigCommerce REST API integration. This server provides AI assistants with the ability to interact with BigCommerce stores through three powerful tools:

🛍️ Products Management: Get all products with advanced filtering
👥 Customer Management: Retrieve and filter customers with comprehensive search options
📦 Order Management: Access orders with customer-product relationship capabilities

✨ Features

✅ MCP-compatible server with built-in tool discovery
✅ Enhanced filtering capabilities on all endpoints
✅ Customer-product association through order history
✅ Comprehensive error handling and validation
✅ Docker support for production deployment
✅ Compatible with Claude Desktop, Cline, and other MCP clients

🚦 Getting Started

⚙️ Prerequisites

Node.js (v18+ required, v20+ recommended)
npm (included with Node)
BigCommerce store with API credentials

📥 Installation & Setup

1. Clone and install dependencies

git clone https://github.com/isaacgounton/bigcommerce-api-mcp.git
cd bigcommerce-api-mcp
npm install

2. Configure your BigCommerce credentials

Create a .env file in the project root:

BIGCOMMERCE_STORE_HASH=your_store_hash_here
BIGCOMMERCE_API_KEY=your_api_key_here

How to get your BigCommerce credentials:

Go to your BigCommerce admin panel
Navigate to Advanced Settings > API Accounts
Create a new API account with the following scopes:
- Products: Read-only or Modify
- Orders: Read-only or Modify
- Customers: Read-only or Modify
Copy the Store Hash and Access Token to your .env file

🔧 Available Tools

get_all_products

Retrieve products from your BigCommerce store
Parameters: store_Hash (required)

get_all_customers

Search and filter customers with advanced options
Parameters: store_Hash (required)
Optional filters: email, name, company, phone, customer_group_id, limit, page, date_created, date_modified

get_all_orders

Access orders with customer-product relationship data
Parameters: store_Hash (required)
Optional filters: customer_id, email, status_id, min_id, max_id, limit, page
✨ Special feature: Filter by customer_id to see all products associated with a specific customer

🔗 Client Integration

💬 Claude Desktop

Step 1: Get the absolute paths to node and mcpServer.js:

which node
# Example output: /usr/bin/node

realpath mcpServer.js  
# Example output: /home/user/bigcommerce-api-mcp/mcpServer.js

Step 2: Open Claude Desktop → Settings → Developer → Edit Config and add:

{
  "mcpServers": {
    "bigcommerce": {
      "command": "/usr/bin/node",
      "args": ["/absolute/path/to/your/mcpServer.js"],
      "env": {
        "BIGCOMMERCE_STORE_HASH": "your_store_hash_here",
        "BIGCOMMERCE_API_KEY": "your_api_key_here"
      }
    }
  }
}

Step 3: Restart Claude Desktop. Look for a green circle next to "bigcommerce" in the MCP section.

� Cline (VS Code Extension)

Step 1: Install the Cline extension in VS Code

Step 2: Open VS Code settings and search for "Cline MCP"

Step 3: Add your MCP server configuration:

{
  "cline.mcp.servers": {
    "bigcommerce": {
      "command": "node",
      "args": ["/absolute/path/to/mcpServer.js"],
      "env": {
        "BIGCOMMERCE_STORE_HASH": "your_store_hash_here", 
        "BIGCOMMERCE_API_KEY": "your_api_key_here"
      }
    }
  }
}

🤖 Other MCP Clients

For any MCP-compatible client, use these connection details:

Command: node
Args: ["/path/to/mcpServer.js"]
Environment Variables:
- BIGCOMMERCE_STORE_HASH
- BIGCOMMERCE_API_KEY

🐳 Docker Deployment

Quick Start

1. Build the Docker image:

docker build -t bigcommerce-mcp .

2. Run with environment variables:

docker run -i --rm \
  -e BIGCOMMERCE_STORE_HASH=your_store_hash \
  -e BIGCOMMERCE_API_KEY=your_api_key \
  bigcommerce-mcp

Claude Desktop with Docker

Update your Claude Desktop config to use Docker:

{
  "mcpServers": {
    "bigcommerce": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm", 
        "-e", "BIGCOMMERCE_STORE_HASH=your_store_hash",
        "-e", "BIGCOMMERCE_API_KEY=your_api_key", 
        "bigcommerce-mcp"
      ]
    }
  }
}

Docker Compose (Production)

Create a docker-compose.yml:

version: '3.8'
services:
  bigcommerce-mcp:
    build: .
    environment:
      - BIGCOMMERCE_STORE_HASH=${BIGCOMMERCE_STORE_HASH}
      - BIGCOMMERCE_API_KEY=${BIGCOMMERCE_API_KEY}
    restart: unless-stopped

Then run:

docker-compose up -d

🧪 Testing

Local Testing

Test the server locally to ensure it's working:

# Test tool discovery
echo '{"jsonrpc":"2.0","method":"tools/list","params":{},"id":1}' | node mcpServer.js

# Test a tool call  
echo '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"get_all_products","arguments":{"store_Hash":"your_store_hash"}},"id":2}' | node mcpServer.js

Postman Integration (Optional)

You can also test with Postman Desktop:

Download Postman Desktop
Create a new MCP request with type STDIO
Set command to: node /absolute/path/to/mcpServer.js
Test your tools before connecting to AI clients

🛠️ Advanced Usage

Server Modes

Standard stdio mode (default):

node mcpServer.js

HTTP mode with Server-Sent Events:

node mcpServer.js --sse

Streamable HTTP mode:

node mcpServer.js --streamable-http

Environment Variables

All BigCommerce credentials can be provided via environment variables:

export BIGCOMMERCE_STORE_HASH="your_store_hash"
export BIGCOMMERCE_API_KEY="your_api_key" 
node mcpServer.js

🔍 Tool Examples

Find products associated with a customer

// Use get_all_orders with customer_id filter
{
  "name": "get_all_orders", 
  "arguments": {
    "store_Hash": "your_store_hash",
    "customer_id": "3"
  }
}

Search customers by email

// Use get_all_customers with email filter
{
  "name": "get_all_customers",
  "arguments": {
    "store_Hash": "your_store_hash", 
    "email": "customer@example.com"
  }
}