bigcommerce-api-mcp

isaacgounton/bigcommerce-api-mcp

3.2

If you are the rightful owner of bigcommerce-api-mcp and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The BigCommerce MCP Server is a comprehensive Model Context Protocol server designed for seamless integration with the BigCommerce REST API, enabling AI assistants to interact with BigCommerce stores.

Tools
3
Resources
0
Prompts
0

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

๐Ÿ“ฅ 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:

  1. Go to your BigCommerce admin panel
  2. Navigate to Advanced Settings > API Accounts
  3. Create a new API account with the following scopes:
    • Products: Read-only or Modify
    • Orders: Read-only or Modify
    • Customers: Read-only or Modify
  4. 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:

  1. Download Postman Desktop
  2. Create a new MCP request with type STDIO
  3. Set command to: node /absolute/path/to/mcpServer.js
  4. 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"
  }
}

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

๐Ÿ“„ License

This project is licensed under the MIT License.

๐Ÿ†˜ Support & Questions

๐Ÿš€ What's Next?

This MCP server provides a solid foundation for BigCommerce integration. Possible enhancements include:

  • Additional BigCommerce API endpoints (categories, brands, etc.)
  • Webhook support for real-time updates
  • Advanced filtering and search capabilities
  • Multi-store support
  • Product modification tools (create/update/delete)

Built with โค๏ธ for the MCP community