Bigcommerce Api Mcp
About
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:
Explore
- ✅ 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
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
Bigcommerce Api McpCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
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
- Node.js (v18+ required, v20+ recommended)
- npm (included with Node)
- BigCommerce store with API credentials
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
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
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
echo '{"jsonrpc":"2.0","method":"tools/list","params":{},"id":1}' | node mcpServer.js
echo '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"get_all_products","arguments":{"store_Hash":"your_store_hash"}},"id":2}' | node mcpServer.js
```
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"bigcommerce api mcp": {
"bigcommerce": {
"command": "/usr/bin/node",
"args": [
"/absolute/path/to/your/mcpServer.js"
],
"env": {
"BIGCOMMERCE_STORE_HASH": "your_store_hash_here",
"BIGCOMMERCE_API_TOKEN": "your_api_token_here"
}
}
}
}
}McpServers
{
"bigcommerce": {
"command": "/usr/bin/node",
"args": [
"/absolute/path/to/your/mcpServer.js"
],
"env": {
"BIGCOMMERCE_STORE_HASH": "your_store_hash_here",
"BIGCOMMERCE_API_TOKEN": "your_api_token_here"
}
}
}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:
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
