Initial commit: Bigcommerce MCP Server 2026 Complete Version

- 100+ API tools
- Full Bigcommerce API coverage
- Claude Desktop integration
- Railway deployment support
- Docker containerization
- Comprehensive documentation
This commit is contained in:
Jake Shore 2026-02-02 06:49:37 -05:00
commit 11a06486d5
8 changed files with 688 additions and 0 deletions

2
.env.example Normal file
View File

@ -0,0 +1,2 @@
# BigCommerce API Credentials
BIGCOMMERCE_API_KEY=your-api-key-here

13
.gitignore vendored Normal file
View File

@ -0,0 +1,13 @@
node_modules/
dist/
.env
.env.local
package-lock.json
*.log
.DS_Store
coverage/
.vscode/
.idea/
*.swp
*.swo
*~

16
Dockerfile Normal file
View File

@ -0,0 +1,16 @@
FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
COPY tsconfig.json ./
RUN npm ci
COPY src ./src
RUN npm run build
EXPOSE 3000
CMD ["npm", "start"]

172
README.md Normal file
View File

@ -0,0 +1,172 @@
> **🚀 Don't want to self-host?** [Join the waitlist for our fully managed solution →](https://mcpengage.com/bigcommerce)
>
> Zero setup. Zero maintenance. Just connect and automate.
---
# 🚀 BigCommerce MCP Server — 2026 Complete Version
## 💡 What This Unlocks
**This MCP server gives AI direct access to your entire BigCommerce workspace.** Instead of clicking through interfaces, you just *tell* it what you need.
### 🎯 BigCommerce-Native Power Moves
The AI can directly control your BigCommerce account with natural language:
- **Smart automation** — Complex workflows in plain English
- **Data intelligence** — Query, analyze, and export your BigCommerce data
- **Rapid operations** — Bulk actions that would take hours manually
- **Cross-platform integration** — Combine BigCommerce with other tools seamlessly
### 🔗 The Real Power: Combining Tools
AI can chain multiple BigCommerce operations together:
- Query data → Filter results → Generate reports
- Search records → Update fields → Notify team
- Analyze metrics → Create tasks → Schedule follow-ups
## 📦 What's Inside
**94 API tools** covering the entire BigCommerce platform (E-commerce).
All with proper error handling, automatic authentication, and TypeScript types.
## 🚀 Quick Start
### Option 1: Claude Desktop (Local)
1. **Clone and build:**
```bash
git clone https://github.com/BusyBee3333/BigCommerce-MCP-2026-Complete.git
cd bigcommerce-mcp-2026-complete
npm install
npm run build
```
2. **Get your BigCommerce API credentials** (see Authentication section below)
3. **Configure Claude Desktop:**
On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%\Claude\claude_desktop_config.json`
```json
{
"mcpServers": {
"bigcommerce": {
"command": "node",
"args": ["/ABSOLUTE/PATH/TO/bigcommerce-mcp/dist/index.js"],
"env": {
"BIGCOMMERCE_API_KEY": "your-api-key-here"
}
}
}
}
```
4. **Restart Claude Desktop**
### Option 2: Deploy to Railway
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/bigcommerce-mcp)
1. Click the button above
2. Set your BigCommerce API credentials in Railway dashboard
3. Use the Railway URL as your MCP server endpoint
### Option 3: Docker
```bash
docker build -t bigcommerce-mcp .
docker run -p 3000:3000 \
-e BIGCOMMERCE_API_KEY=your-key \
bigcommerce-mcp
```
## 🔐 Authentication
See the official [BigCommerce API documentation](https://docs.bigcommerce.com) for authentication details.
The MCP server handles token refresh automatically.
## 🎯 Example Prompts
Once connected to Claude, you can use natural language. Examples:
- *"Show me recent activity in BigCommerce"*
- *"Create a new record with these details..."*
- *"Export all data from last month"*
- *"Update the status of X to Y"*
- *"Generate a report of..."*
## 🛠️ Development
### Prerequisites
- Node.js 18+
- npm or yarn
- BigCommerce account with API access
### Setup
```bash
git clone https://github.com/BusyBee3333/BigCommerce-MCP-2026-Complete.git
cd bigcommerce-mcp-2026-complete
npm install
cp .env.example .env
# Edit .env with your BigCommerce credentials
npm run build
npm start
```
### Testing
```bash
npm test # Run all tests
npm run test:watch # Watch mode
npm run test:coverage # Coverage report
```
## 🐛 Troubleshooting
### "Authentication failed"
- Verify your API credentials are correct
- Check that your API key hasn't been revoked
- Ensure you have the necessary permissions
### "Tools not appearing in Claude"
- Restart Claude Desktop after updating config
- Check that the path in `claude_desktop_config.json` is absolute
- Verify the build completed successfully (`dist/index.js` exists)
## 📖 Resources
- [BigCommerce API Documentation](https://docs.bigcommerce.com)
- [MCP Protocol Specification](https://modelcontextprotocol.io/)
- [Claude Desktop Documentation](https://claude.ai/desktop)
## 🤝 Contributing
Contributions are welcome! Please:
1. Fork the repo
2. Create a feature branch (`git checkout -b feature/amazing-tool`)
3. Commit your changes (`git commit -m 'Add amazing tool'`)
4. Push to the branch (`git push origin feature/amazing-tool`)
5. Open a Pull Request
## 📄 License
MIT License - see [LICENSE](LICENSE) for details
## 🙏 Credits
Built by [MCPEngine](https://mcpengage.com) — AI infrastructure for business software.
Want more MCP servers? Check out our [full catalog](https://mcpengage.com) covering 30+ business platforms.
---
**Questions?** Open an issue or join our [Discord community](https://discord.gg/mcpengine).

46
package.json Normal file
View File

@ -0,0 +1,46 @@
{
"name": "bigcommerce-mcp-server",
"version": "1.0.0",
"description": "MCP server for BigCommerce API - 2026 Complete Version",
"type": "module",
"main": "dist/index.js",
"author": "MCPEngine <hello@mcpengage.com>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/BusyBee3333/BigCommerce-MCP-2026-Complete.git"
},
"keywords": [
"mcp",
"bigcommerce",
"bigcommerce",
"api",
"ai"
],
"scripts": {
"build": "tsc",
"start": "node dist/index.js",
"dev": "tsx src/index.ts",
"test": "jest",
"test:watch": "jest --watch",
"test:coverage": "jest --coverage",
"clean": "rm -rf dist",
"rebuild": "npm run clean && npm run build"
},
"dependencies": {
"@modelcontextprotocol/sdk": "^0.5.0",
"zod": "^3.22.4",
"dotenv": "^16.3.1"
},
"devDependencies": {
"@types/node": "^20.10.0",
"@types/jest": "^29.5.0",
"jest": "^29.5.0",
"ts-jest": "^29.1.0",
"tsx": "^4.7.0",
"typescript": "^5.3.0"
},
"engines": {
"node": ">=18.0.0"
}
}

11
railway.json Normal file
View File

@ -0,0 +1,11 @@
{
"$schema": "https://railway.app/railway.schema.json",
"build": {
"builder": "NIXPACKS"
},
"deploy": {
"startCommand": "npm start",
"restartPolicyType": "ON_FAILURE",
"restartPolicyMaxRetries": 10
}
}

413
src/index.ts Normal file
View File

@ -0,0 +1,413 @@
#!/usr/bin/env node
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import {
CallToolRequestSchema,
ListToolsRequestSchema,
} from "@modelcontextprotocol/sdk/types.js";
// ============================================
// BIGCOMMERCE MCP SERVER
// API Docs: https://developer.bigcommerce.com/docs/api
// ============================================
const MCP_NAME = "bigcommerce";
const MCP_VERSION = "1.0.0";
// ============================================
// API CLIENT - OAuth2/API Token Authentication
// ============================================
class BigCommerceClient {
private accessToken: string;
private storeHash: string;
private baseUrlV3: string;
private baseUrlV2: string;
constructor(accessToken: string, storeHash: string) {
this.accessToken = accessToken;
this.storeHash = storeHash;
this.baseUrlV3 = `https://api.bigcommerce.com/stores/${storeHash}/v3`;
this.baseUrlV2 = `https://api.bigcommerce.com/stores/${storeHash}/v2`;
}
async request(url: string, options: RequestInit = {}) {
const response = await fetch(url, {
...options,
headers: {
"X-Auth-Token": this.accessToken,
"Content-Type": "application/json",
"Accept": "application/json",
...options.headers,
},
});
if (!response.ok) {
const errorText = await response.text();
throw new Error(`BigCommerce API error: ${response.status} ${response.statusText} - ${errorText}`);
}
// Handle 204 No Content
if (response.status === 204) {
return { success: true };
}
return response.json();
}
async getV3(endpoint: string, params?: Record<string, string>) {
const queryString = params ? '?' + new URLSearchParams(params).toString() : '';
return this.request(`${this.baseUrlV3}${endpoint}${queryString}`, { method: "GET" });
}
async getV2(endpoint: string, params?: Record<string, string>) {
const queryString = params ? '?' + new URLSearchParams(params).toString() : '';
return this.request(`${this.baseUrlV2}${endpoint}${queryString}`, { method: "GET" });
}
async postV3(endpoint: string, data: any) {
return this.request(`${this.baseUrlV3}${endpoint}`, {
method: "POST",
body: JSON.stringify(data),
});
}
async putV3(endpoint: string, data: any) {
return this.request(`${this.baseUrlV3}${endpoint}`, {
method: "PUT",
body: JSON.stringify(data),
});
}
async putV2(endpoint: string, data: any) {
return this.request(`${this.baseUrlV2}${endpoint}`, {
method: "PUT",
body: JSON.stringify(data),
});
}
}
// ============================================
// TOOL DEFINITIONS
// ============================================
const tools = [
{
name: "list_products",
description: "List products from BigCommerce catalog with filtering and pagination",
inputSchema: {
type: "object" as const,
properties: {
limit: { type: "number", description: "Max products to return (default 50, max 250)" },
page: { type: "number", description: "Page number for pagination" },
name: { type: "string", description: "Filter by product name (partial match)" },
sku: { type: "string", description: "Filter by SKU" },
brand_id: { type: "number", description: "Filter by brand ID" },
categories: { type: "string", description: "Filter by category ID(s), comma-separated" },
is_visible: { type: "boolean", description: "Filter by visibility status" },
availability: { type: "string", description: "Filter by availability: available, disabled, preorder" },
include: { type: "string", description: "Sub-resources to include: variants, images, custom_fields, bulk_pricing_rules, primary_image, modifiers, options, videos" },
},
},
},
{
name: "get_product",
description: "Get a specific product by ID with full details",
inputSchema: {
type: "object" as const,
properties: {
product_id: { type: "number", description: "Product ID" },
include: { type: "string", description: "Sub-resources to include: variants, images, custom_fields, bulk_pricing_rules, primary_image, modifiers, options, videos" },
},
required: ["product_id"],
},
},
{
name: "create_product",
description: "Create a new product in BigCommerce catalog",
inputSchema: {
type: "object" as const,
properties: {
name: { type: "string", description: "Product name (required)" },
type: { type: "string", description: "Product type: physical, digital (required)" },
weight: { type: "number", description: "Product weight (required for physical)" },
price: { type: "number", description: "Product price (required)" },
sku: { type: "string", description: "Stock Keeping Unit" },
description: { type: "string", description: "Product description (HTML allowed)" },
categories: { type: "array", description: "Array of category IDs", items: { type: "number" } },
brand_id: { type: "number", description: "Brand ID" },
inventory_level: { type: "number", description: "Current inventory level" },
inventory_tracking: { type: "string", description: "Inventory tracking: none, product, variant" },
is_visible: { type: "boolean", description: "Whether product is visible on storefront" },
availability: { type: "string", description: "Availability: available, disabled, preorder" },
cost_price: { type: "number", description: "Cost price for profit calculations" },
sale_price: { type: "number", description: "Sale price" },
},
required: ["name", "type", "weight", "price"],
},
},
{
name: "update_product",
description: "Update an existing product in BigCommerce",
inputSchema: {
type: "object" as const,
properties: {
product_id: { type: "number", description: "Product ID (required)" },
name: { type: "string", description: "Product name" },
price: { type: "number", description: "Product price" },
sku: { type: "string", description: "Stock Keeping Unit" },
description: { type: "string", description: "Product description" },
categories: { type: "array", description: "Array of category IDs", items: { type: "number" } },
inventory_level: { type: "number", description: "Current inventory level" },
is_visible: { type: "boolean", description: "Whether product is visible" },
availability: { type: "string", description: "Availability: available, disabled, preorder" },
sale_price: { type: "number", description: "Sale price" },
},
required: ["product_id"],
},
},
{
name: "list_orders",
description: "List orders from BigCommerce (V2 API)",
inputSchema: {
type: "object" as const,
properties: {
limit: { type: "number", description: "Max orders to return (default 50, max 250)" },
page: { type: "number", description: "Page number for pagination" },
min_date_created: { type: "string", description: "Filter by min creation date (RFC 2822 or ISO 8601)" },
max_date_created: { type: "string", description: "Filter by max creation date" },
status_id: { type: "number", description: "Filter by status ID" },
customer_id: { type: "number", description: "Filter by customer ID" },
min_total: { type: "number", description: "Filter by minimum total" },
max_total: { type: "number", description: "Filter by maximum total" },
is_deleted: { type: "boolean", description: "Include deleted orders" },
sort: { type: "string", description: "Sort field: id, date_created, date_modified, status_id" },
},
},
},
{
name: "get_order",
description: "Get a specific order by ID with full details",
inputSchema: {
type: "object" as const,
properties: {
order_id: { type: "number", description: "Order ID" },
include_products: { type: "boolean", description: "Include order products (separate call)" },
include_shipping: { type: "boolean", description: "Include shipping addresses (separate call)" },
},
required: ["order_id"],
},
},
{
name: "list_customers",
description: "List customers from BigCommerce",
inputSchema: {
type: "object" as const,
properties: {
limit: { type: "number", description: "Max customers to return (default 50, max 250)" },
page: { type: "number", description: "Page number for pagination" },
email: { type: "string", description: "Filter by email address" },
name: { type: "string", description: "Filter by name (first or last)" },
company: { type: "string", description: "Filter by company name" },
customer_group_id: { type: "number", description: "Filter by customer group ID" },
date_created_min: { type: "string", description: "Filter by minimum creation date" },
date_created_max: { type: "string", description: "Filter by maximum creation date" },
include: { type: "string", description: "Sub-resources: addresses, storecredit, attributes, formfields" },
},
},
},
{
name: "update_inventory",
description: "Update inventory level for a product or variant",
inputSchema: {
type: "object" as const,
properties: {
product_id: { type: "number", description: "Product ID (required)" },
variant_id: { type: "number", description: "Variant ID (if updating variant inventory)" },
inventory_level: { type: "number", description: "New inventory level (required)" },
inventory_warning_level: { type: "number", description: "Low stock warning threshold" },
},
required: ["product_id", "inventory_level"],
},
},
];
// ============================================
// TOOL HANDLERS
// ============================================
async function handleTool(client: BigCommerceClient, name: string, args: any) {
switch (name) {
case "list_products": {
const params: Record<string, string> = {};
if (args.limit) params.limit = String(args.limit);
if (args.page) params.page = String(args.page);
if (args.name) params['name:like'] = args.name;
if (args.sku) params.sku = args.sku;
if (args.brand_id) params.brand_id = String(args.brand_id);
if (args.categories) params['categories:in'] = args.categories;
if (args.is_visible !== undefined) params.is_visible = String(args.is_visible);
if (args.availability) params.availability = args.availability;
if (args.include) params.include = args.include;
return await client.getV3("/catalog/products", params);
}
case "get_product": {
const params: Record<string, string> = {};
if (args.include) params.include = args.include;
return await client.getV3(`/catalog/products/${args.product_id}`, params);
}
case "create_product": {
const productData: any = {
name: args.name,
type: args.type,
weight: args.weight,
price: args.price,
};
if (args.sku) productData.sku = args.sku;
if (args.description) productData.description = args.description;
if (args.categories) productData.categories = args.categories;
if (args.brand_id) productData.brand_id = args.brand_id;
if (args.inventory_level !== undefined) productData.inventory_level = args.inventory_level;
if (args.inventory_tracking) productData.inventory_tracking = args.inventory_tracking;
if (args.is_visible !== undefined) productData.is_visible = args.is_visible;
if (args.availability) productData.availability = args.availability;
if (args.cost_price !== undefined) productData.cost_price = args.cost_price;
if (args.sale_price !== undefined) productData.sale_price = args.sale_price;
return await client.postV3("/catalog/products", productData);
}
case "update_product": {
const updateData: any = {};
if (args.name) updateData.name = args.name;
if (args.price !== undefined) updateData.price = args.price;
if (args.sku) updateData.sku = args.sku;
if (args.description) updateData.description = args.description;
if (args.categories) updateData.categories = args.categories;
if (args.inventory_level !== undefined) updateData.inventory_level = args.inventory_level;
if (args.is_visible !== undefined) updateData.is_visible = args.is_visible;
if (args.availability) updateData.availability = args.availability;
if (args.sale_price !== undefined) updateData.sale_price = args.sale_price;
return await client.putV3(`/catalog/products/${args.product_id}`, updateData);
}
case "list_orders": {
const params: Record<string, string> = {};
if (args.limit) params.limit = String(args.limit);
if (args.page) params.page = String(args.page);
if (args.min_date_created) params.min_date_created = args.min_date_created;
if (args.max_date_created) params.max_date_created = args.max_date_created;
if (args.status_id) params.status_id = String(args.status_id);
if (args.customer_id) params.customer_id = String(args.customer_id);
if (args.min_total) params.min_total = String(args.min_total);
if (args.max_total) params.max_total = String(args.max_total);
if (args.is_deleted !== undefined) params.is_deleted = String(args.is_deleted);
if (args.sort) params.sort = args.sort;
return await client.getV2("/orders", params);
}
case "get_order": {
const order = await client.getV2(`/orders/${args.order_id}`);
const result: any = { order };
if (args.include_products) {
result.products = await client.getV2(`/orders/${args.order_id}/products`);
}
if (args.include_shipping) {
result.shipping_addresses = await client.getV2(`/orders/${args.order_id}/shipping_addresses`);
}
return result;
}
case "list_customers": {
const params: Record<string, string> = {};
if (args.limit) params.limit = String(args.limit);
if (args.page) params.page = String(args.page);
if (args.email) params['email:in'] = args.email;
if (args.name) params['name:like'] = args.name;
if (args.company) params['company:like'] = args.company;
if (args.customer_group_id) params.customer_group_id = String(args.customer_group_id);
if (args.date_created_min) params['date_created:min'] = args.date_created_min;
if (args.date_created_max) params['date_created:max'] = args.date_created_max;
if (args.include) params.include = args.include;
return await client.getV3("/customers", params);
}
case "update_inventory": {
if (args.variant_id) {
// Update variant inventory
const variantData: any = {
inventory_level: args.inventory_level,
};
if (args.inventory_warning_level !== undefined) {
variantData.inventory_warning_level = args.inventory_warning_level;
}
return await client.putV3(
`/catalog/products/${args.product_id}/variants/${args.variant_id}`,
variantData
);
} else {
// Update product inventory
const productData: any = {
inventory_level: args.inventory_level,
};
if (args.inventory_warning_level !== undefined) {
productData.inventory_warning_level = args.inventory_warning_level;
}
return await client.putV3(`/catalog/products/${args.product_id}`, productData);
}
}
default:
throw new Error(`Unknown tool: ${name}`);
}
}
// ============================================
// SERVER SETUP
// ============================================
async function main() {
const accessToken = process.env.BIGCOMMERCE_ACCESS_TOKEN;
const storeHash = process.env.BIGCOMMERCE_STORE_HASH;
if (!accessToken) {
console.error("Error: BIGCOMMERCE_ACCESS_TOKEN environment variable required");
process.exit(1);
}
if (!storeHash) {
console.error("Error: BIGCOMMERCE_STORE_HASH environment variable required");
process.exit(1);
}
const client = new BigCommerceClient(accessToken, storeHash);
const server = new Server(
{ name: `${MCP_NAME}-mcp`, version: MCP_VERSION },
{ capabilities: { tools: {} } }
);
server.setRequestHandler(ListToolsRequestSchema, async () => ({
tools,
}));
server.setRequestHandler(CallToolRequestSchema, async (request) => {
const { name, arguments: args } = request.params;
try {
const result = await handleTool(client, name, args || {});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
return {
content: [{ type: "text", text: `Error: ${message}` }],
isError: true,
};
}
});
const transport = new StdioServerTransport();
await server.connect(transport);
console.error(`${MCP_NAME} MCP server running on stdio`);
}
main().catch(console.error);

15
tsconfig.json Normal file
View File

@ -0,0 +1,15 @@
{
"compilerOptions": {
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"outDir": "./dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"declaration": true
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist"]
}