Rebrand to MCPEngage and customize BigCommerce README with e-commerce power moves

2026-02-02 06:58:50 -05:00 · 2026-02-02 06:58:50 -05:00 · 323b70981d
commit 323b70981d
parent 11a06486d5
3 changed files with 87 additions and 33 deletions
--- a/.env.example
+++ b/.env.example
@ -1,2 +1,4 @@
 # BigCommerce API Credentials
-BIGCOMMERCE_API_KEY=your-api-key-here
+# Get these from: Settings → API → API Accounts → Create API Account
+BIGCOMMERCE_ACCESS_TOKEN=your-access-token-here
+BIGCOMMERCE_STORE_HASH=your-store-hash
--- a/README.md
+++ b/README.md
@ -8,28 +8,38 @@

 ## 💡 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.
+**This MCP server gives AI direct access to your BigCommerce e-commerce store.** Instead of manually managing products, orders, and inventory through the dashboard, you just *tell* the AI what you need — in plain English.

-### 🎯 BigCommerce-Native Power Moves
+### 🎯 E-Commerce Power Moves

-The AI can directly control your BigCommerce account with natural language:
+The AI can directly control your BigCommerce store 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
+1. **Inventory Intelligence** — "Check stock levels for all products under 10 units and flag which need reordering"
+2. **Order Fulfillment** — "Show me all pending orders from the last 3 days and update their status to shipped"
+3. **Product Management** — "Create 5 new product variants for our summer collection with pricing tiers"
+4. **Customer Insights** — "List all customers who made purchases over $500 in the last month"
+5. **Bulk Operations** — "Update inventory for all 'winter collection' items to clearance pricing"

 ### 🔗 The Real Power: Combining Tools

-AI can chain multiple BigCommerce operations together:
+AI can chain multiple BigCommerce operations together in one conversation:

- Query data → Filter results → Generate reports
- Search records → Update fields → Notify team
- Analyze metrics → Create tasks → Schedule follow-ups
+- Query low-stock items → Generate reorder report → Update inventory levels
+- Search high-value orders → Export customer emails → Create marketing segment
+- Analyze product performance → Adjust pricing → Notify sales team
+- Pull order data → Match with inventory → Generate fulfillment list

 ## 📦 What's Inside

-**94 API tools** covering the entire BigCommerce platform (E-commerce).
+**8 powerful API tools** covering the BigCommerce e-commerce platform:
+- `list_products` — Browse catalog with filtering and pagination
+- `get_product` — Get full product details
+- `create_product` — Add new products to catalog
+- `update_product` — Modify existing products
+- `list_orders` — Query orders with advanced filters
+- `get_order` — Get complete order details
+- `list_customers` — Browse customer database
+- `update_inventory` — Adjust stock levels

 All with proper error handling, automatic authentication, and TypeScript types.

@ -45,7 +55,11 @@ All with proper error handling, automatic authentication, and TypeScript types.
   npm run build
   ```

-2. **Get your BigCommerce API credentials** (see Authentication section below)
+2. **Get your BigCommerce API credentials:**
+   - Log in to your BigCommerce control panel
+   - Go to **Settings → API → API Accounts → Create API Account**
+   - Set permissions: **Products** (modify), **Orders** (read), **Customers** (read)
+   - Copy your **Access Token** and **Store Hash** (from store URL: `store-{HASH}.mybigcommerce.com`)

 3. **Configure Claude Desktop:**
   
@ -58,9 +72,10 @@ All with proper error handling, automatic authentication, and TypeScript types.
     "mcpServers": {
       "bigcommerce": {
         "command": "node",
-         "args": ["/ABSOLUTE/PATH/TO/bigcommerce-mcp/dist/index.js"],
+         "args": ["/ABSOLUTE/PATH/TO/bigcommerce-mcp-2026-complete/dist/index.js"],
         "env": {
-           "BIGCOMMERCE_API_KEY": "your-api-key-here"
+           "BIGCOMMERCE_ACCESS_TOKEN": "your-access-token-here",
+           "BIGCOMMERCE_STORE_HASH": "your-store-hash"
         }
       }
     }
@ -82,32 +97,63 @@ All with proper error handling, automatic authentication, and TypeScript types.
 ```bash
 docker build -t bigcommerce-mcp .
 docker run -p 3000:3000 \
-  -e BIGCOMMERCE_API_KEY=your-key \
+  -e BIGCOMMERCE_ACCESS_TOKEN=your-token \
+  -e BIGCOMMERCE_STORE_HASH=your-hash \
  bigcommerce-mcp
 ```

 ## 🔐 Authentication

-See the official [BigCommerce API documentation](https://docs.bigcommerce.com) for authentication details.
+**BigCommerce uses API Account authentication with Store Hash + Access Token.**

-The MCP server handles token refresh automatically.
+**Setup Steps:**
+1. In BigCommerce admin: **Settings → API → API Accounts → Create API Account**
+2. Choose **V3 API** scope (recommended for this server)
+3. Set OAuth Scopes:
+   - **Products**: Read-only or Modify (required for product tools)
+   - **Orders**: Read-only (required for order tools)
+   - **Customers**: Read-only (required for customer tools)
+4. Save credentials securely
+
+**API Documentation:** https://developer.bigcommerce.com/docs/rest-management/authentication
+
+The MCP server handles all API requests automatically using your credentials.

 ## 🎯 Example Prompts

-Once connected to Claude, you can use natural language. Examples:
+Once connected to Claude, you can use natural language for e-commerce operations:

- *"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..."*
+**Inventory Management:**
+- *"Show me all products with inventory below 5 units"*
+- *"Update inventory for product ID 123 to 50 units"*
+- *"List all out-of-stock items in the 'Electronics' category"*
+
+**Order Fulfillment:**
+- *"Get all orders placed in the last 48 hours"*
+- *"Show me order details for order #45678 including products and shipping"*
+- *"List orders over $200 from this week"*
+
+**Product Management:**
+- *"Create a new product called 'Premium Headphones' priced at $99.99"*
+- *"Update the price of SKU 'SUMMER-2024' to $79.99"*
+- *"Show me all products in the 'Winter Sale' category"*
+
+**Customer Intelligence:**
+- *"List customers who joined in the last 30 days"*
+- *"Find all customers with email containing '@company.com'"*
+- *"Show me customers in the VIP customer group"*
+
+**Bulk Operations:**
+- *"Generate a report of all products needing restock"*
+- *"Export all order data from January 2024"*
+- *"List all visible products with sale prices"*

 ## 🛠️ Development

 ### Prerequisites
 - Node.js 18+
 - npm or yarn
- BigCommerce account with API access
+- BigCommerce store with API access

 ### Setup

@ -132,18 +178,24 @@ 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
+- Verify your **Access Token** and **Store Hash** are correct
+- Check that your API account hasn't been deleted/revoked
+- Ensure your API account has the necessary OAuth scopes enabled

 ### "Tools not appearing in Claude"
 - Restart Claude Desktop after updating config
- Check that the path in `claude_desktop_config.json` is absolute
+- Check that the path in `claude_desktop_config.json` is **absolute** (not relative)
 - Verify the build completed successfully (`dist/index.js` exists)

+### "API rate limit exceeded"
+- BigCommerce has rate limits: 20,000 requests/hour (standard plans)
+- The server respects rate limits automatically
+- Consider spreading large operations over time
+
 ## 📖 Resources

- [BigCommerce API Documentation](https://docs.bigcommerce.com)
+- [BigCommerce API Documentation](https://developer.bigcommerce.com/docs/rest-management)
+- [BigCommerce API Reference](https://developer.bigcommerce.com/api-reference)
 - [MCP Protocol Specification](https://modelcontextprotocol.io/)
 - [Claude Desktop Documentation](https://claude.ai/desktop)

@ -163,7 +215,7 @@ MIT License - see [LICENSE](LICENSE) for details

 ## 🙏 Credits

-Built by [MCPEngine](https://mcpengage.com) — AI infrastructure for business software.
+Built by [MCPEngage](https://mcpengage.com) — AI infrastructure for business software.

 Want more MCP servers? Check out our [full catalog](https://mcpengage.com) covering 30+ business platforms.

--- a/package.json
+++ b/package.json
@ -4,7 +4,7 @@
  "description": "MCP server for BigCommerce API - 2026 Complete Version",
  "type": "module",
  "main": "dist/index.js",
-  "author": "MCPEngine <hello@mcpengage.com>",
+  "author": "MCPEngage <hello@mcpengage.com>",
  "license": "MIT",
  "repository": {
    "type": "git",