Bigcommerce Api Mcp

by isaacgounton

240 downloads
Not rated
GitHub

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:

Details

Author
isaacgounton
Downloads
240
Categories
Developer Tools

- MCP‑compatible server with built‑in tool discovery
- Enhanced filtering 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:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Bigcommerce Api Mcp
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Clone the repository, install dependencies with npm install, configure your BigCommerce credentials in a .env file (BIGCOMMERCE_STORE_HASH and BIGCOMMERCE_API_KEY), then run node mcpServer.js. The server can also be deployed via Docker or used with MCP clients like Claude Desktop and Cline.

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 → SettingsDeveloperEdit Config and add:

json
{
"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:

json
{
"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:

sh
docker build -t bigcommerce-mcp .

2. Run with environment variables:

sh
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:

json
{
"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:

yaml
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:

sh
docker-compose up -d

🧪 Testing

Local Testing

Test the server locally to ensure it's working:

sh

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.