Swell MCP
About
# Swell MCP Server A Model Context Protocol server that integrates AI assistants with Swell's e-commerce platform. Built on a production-ready TypeScript foundation, it provides comprehensive access to Swell stores for product management, order processing, and customer management through both CLI and MCP tool…
Explore
- Swell E-commerce Integration: Complete access to Swell's API for products, orders, and customers
- Dual Transport Support: STDIO and HTTP transports for AI assistant and web integration
- 5-Layer Architecture: Clean separation between CLI, tools, controllers, services, and utilities
- Type Safety: Full TypeScript implementation with Zod schema validation
- Advanced HTTP Client: Built on swell-node SDK with connection pooling and retry logic
- Comprehensive Testing: Unit and integration tests with Swell API mocking
- Production Tooling: ESLint, Prettier, semantic-release, and MCP Inspector integration
- Error Handling: Structured error handling with Swell-specific error contexts
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
Swell 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
First, install the Swell MCP server with your AI assistant or MCP client.
Go to Cursor Settings -> MCP -> Add new MCP Server. Name it "Swell MCP", use command type with the command npx swell-mcp. Add your Swell credentials in the environment variables section.
</details>
<details>
<summary>VS Code</summary>
Follow the MCP install guide, use the standard config above. You can also install the Swell MCP server using the VS Code CLI:
bash
1. Log into your Swell dashboard at login.swell.store
2. Navigate to Developer → API Keys
3. Copy your Store ID (this is your SWELL_STORE_ID)
4. Copy your Secret Key (this is your SWELL_SECRET_KEY - use the backend/admin key, not the public key)
- SWELL_STORE_ID: Your Swell store identifier (required)
- SWELL_SECRET_KEY: Your Swell secret/private key (required)
- DEBUG: Set to "true" to enable debug mode with raw JSON responses (optional)
{
"mcpServers": {
"swell-mcp": {
"command": "npx",
"args": ["swell-mcp"],
"env": {
"DEBUG": "false",
"SWELL_STORE_ID": "my-awesome-store",
"SWELL_SECRET_KEY": "sk_live_abc123def456..."
},
"disabled": false
}
}
}
For developers who want to contribute or modify the server:
npm install
cp .env.example .env
- TRANSPORT_MODE: Transport mode (stdio | http, default: stdio)
- PORT: HTTP server port (default: 3000)
- DEBUG: Enable debug logging (true | false, default: false)
- SWELL_STORE_ID: Your Swell store ID (required)
- SWELL_SECRET_KEY: Your Swell secret key (required)
TRANSPORT_MODE=http
PORT=3001
DEBUG=true
If you want to run the server independently (not through an MCP client):
npm install -g swell-mcp
bash
npm test # Run all tests
npm run test:coverage # Generate coverage report
npm run test:cli # CLI-specific tests only
```swell_list_products
List products with filtering and pagination
swell_get_product
Get detailed product information
swell_search_products
Search products with multiple criteria
swell_check_inventory
Check product inventory levels
swell_list_orders
List orders with filtering options
swell_get_order
Get detailed order information
swell_update_order_status
Update order status
swell_list_customers
List customers with search capabilities
swell_get_customer
Get detailed customer information
swell_search_customers
Search customers with multiple criteria
MCP Tools:
- swell_list_products - List products with filtering and pagination
- swell_get_product - Get detailed product information
- swell_search_products - Search products with multiple criteria
- swell_check_inventory - Check product inventory levels
- swell_list_orders - List orders with filtering options
- swell_get_order - Get detailed order information
- swell_update_order_status - Update order status
- swell_list_customers - List customers with search capabilities
- swell_get_customer - Get detailed customer information
- swell_search_customers - Search customers with multiple criteria
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"swell mcp": {
"swell-mcp": {
"command": "npx",
"args": [
"swell-mcp"
],
"env": {
"SWELL_STORE_ID": "",
"SWELL_SECRET_KEY": ""
}
}
}
}
}
McpServers
{
"swell-mcp": {
"command": "npx",
"args": [
"swell-mcp"
],
"env": {
"SWELL_STORE_ID": "",
"SWELL_SECRET_KEY": ""
}
}
}
A Model Context Protocol server that integrates AI assistants with Swell's e-commerce platform. Built on a production-ready TypeScript foundation, it provides comprehensive access to Swell stores for product management, order processing, and customer management through both CLI and MCP tool interfaces.
Built by Devkind - Official Swell Partners serving businesses globally with cutting-edge e-commerce solutions.
Features
- Swell E-commerce Integration: Complete access to Swell's API for products, orders, and customers
- Dual Transport Support: STDIO and HTTP transports for AI assistant and web integration
- 5-Layer Architecture: Clean separation between CLI, tools, controllers, services, and utilities
- Type Safety: Full TypeScript implementation with Zod schema validation
- Advanced HTTP Client: Built on swell-node SDK with connection pooling and retry logic
- Comprehensive Testing: Unit and integration tests with Swell API mocking
- Production Tooling: ESLint, Prettier, semantic-release, and MCP Inspector integration
- Error Handling: Structured error handling with Swell-specific error contexts
Swell E-commerce Integration
This MCP server provides comprehensive integration with Swell's e-commerce platform:
Available Tools & Commands
MCP Tools:
- swell_list_products - List products with filtering and pagination
- swell_get_product - Get detailed product information
- swell_search_products - Search products with multiple criteria
- swell_check_inventory - Check product inventory levels
- swell_list_orders - List orders with filtering options
- swell_get_order - Get detailed order information
- swell_update_order_status - Update order status
- swell_list_customers - List customers with search capabilities
- swell_get_customer - Get detailed customer information
- swell_search_customers - Search customers with multiple criteria
Features Demonstrated
- Product Management: Complete product catalog access with inventory tracking
- Order Processing: Order lifecycle management with status updates
- Customer Management: Customer profiles with order history and analytics
- Error Handling: Structured errors for API failures and validation issues
- Response Formatting: Clean Markdown output with structured data tables
Configuration Requirements
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.



