CS-Cart MCP Server

CS-Cart MCP Server

A Model Context Protocol (MCP) server that provides comprehensive tools for managing CS-Cart e-commerce stores, including product management, order handling, and sales analytics.

Features

Product Management

• get_products: Retrieve product listings with filtering and pagination
• get_product: Get detailed product information
• create_product: Add new products to the store
• update_product: Modify existing product details
• delete_product: Remove products from the store
• update_product_stock: Update product inventory levels

Order Management

• get_orders: Retrieve order listings with various filters
• get_order: Get detailed order information
• update_order_status: Change order status and notify customers

Category Management

• get_categories: Retrieve product categories and subcategories

User Management

• get_users: Get customer and user information

Analytics

• get_sales_statistics: Retrieve sales data and statistics

Installation

Option 1: Quick Setup (Recommended)

1. Clone this repository:

2. Run the setup script:

3. Install dependencies:

4. Update .env with your CS-Cart credentials and start:

Option 2: Manual Local Installation

1. Clone this repository:

2. Install dependencies:

3. Configure environment variables:

Edit .env with your CS-Cart API credentials:

Option 2: Docker Installation

1. Clone this repository:

2. Configure environment variables:

3. Build and run with Docker Compose:

Or build and run with Docker:

Option 3: Production Docker Build

For production deployment with optimized image:

CS-Cart API Setup

1. Enable API Access:
   • Log into your CS-Cart admin panel
   • Go to Administration → API access
   • Enable API access for your store
2. Generate API Key:
   • Create a new API key or use existing one
   • Note the API key and admin email for configuration
3. API Permissions:
   • Ensure the API user has appropriate permissions for:
     • Products (read/write)
     • Orders (read/write)
     • Categories (read)
     • Users (read)
     • Statistics (read)

Usage

Running the Server

Quick Commands

Docker Deployment

Start with Docker Compose:

View logs:

Stop the service:

Production Deployment

For production use the optimized Dockerfile:

Integration with MCP Clients

Add this server to your MCP client configuration. For example, with Claude Desktop:

Note: Use the full path to the node executable. Common paths:

• macOS: /usr/local/bin/node or /opt/homebrew/bin/node
• Linux: /usr/bin/node or /usr/local/bin/node
• Windows: C:\\Program Files\\nodejs\\node.exe

Integration with AnythingLLM

To integrate this MCP server with AnythingLLM:

1. Navigate to AnythingLLM Settings:
   • Open your AnythingLLM instance
   • Go to Settings → Integrations → MCP Servers
2. Add the CS-Cart MCP Server:
   { "command": "/usr/local/bin/node", "args": ["/full/path/to/cscart-mcp-server/src/index.js"], "env": { "CSCART_API_URL": "https://your-store.com/api", "CSCART_API_EMAIL": "admin@yourstore.com", "CSCART_API_KEY": "your-api-key-here" } }
3. Important Path Notes:
   • Use the full absolute path to the node executable
   • Use the full absolute path to the src/index.js file
   • Ensure the paths are accessible from the AnythingLLM container/environment
4. Example for macOS:
   { "command": "/usr/local/bin/node", "args": ["/Users/username/GitHub/cscart-mcp/src/index.js"], "env": { "CSCART_API_URL": "https://your-store.com/api", "CSCART_API_EMAIL": "admin@yourstore.com", "CSCART_API_KEY": "your-api-key-here" } }
5. Docker Integration (if AnythingLLM is running in Docker):
   • Mount the CS-Cart MCP server directory as a volume
   • Use the container path in the configuration
   • Ensure proper file permissions
6. Test the Integration:
   • Restart AnythingLLM after adding the MCP server
   • Check the logs for any connection errors
   • Try using CS-Cart tools in your conversations

Available Tools

Product Tools

get_products

Retrieve a list of products with optional filtering:

create_product

Create a new product:

Order Tools

get_orders

Retrieve orders with filtering:

update_order_status

Update order status:

Status Codes

Product Status:

• A - Active
• D - Disabled
• H - Hidden

Order Status:

• O - Open
• P - Processed
• C - Complete
• F - Failed
• D - Declined
• B - Backordered
• I - Incomplete

User Status:

• A - Active
• D - Disabled

User Types:

• A - Admin
• V - Vendor
• C - Customer

Error Handling

The server includes comprehensive error handling:

• API connection errors
• Invalid parameters
• Missing required fields
• CS-Cart API errors

All errors are returned with descriptive messages to help with debugging.

Docker Configuration

Environment Variables

When using Docker, you can set environment variables in several ways:

1. Using .env file (recommended):

2. Using docker-compose.yml:

3. Using Docker run command:

Docker Images

• Dockerfile: Standard development image (~200MB)
• Dockerfile.production: Optimized production image (~150MB)
  • Multi-stage build for smaller size
  • Non-root user for security
  • Proper signal handling with dumb-init
  • Health checks included

Resource Limits

The docker-compose.yml includes resource limits:

• CPU: 0.5 cores max, 0.25 cores reserved
• Memory: 512MB max, 256MB reserved

Adjust these based on your server capacity and usage requirements.

Project Structure

Adding New Tools

To add new tools, extend the ListToolsRequestSchema handler and add corresponding methods to the CSCartMCPServer class.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For issues related to:

• CS-Cart API: Check CS-Cart documentation or support
• MCP Protocol: Refer to MCP documentation
• This Server: Open an issue in this repository

Changelog

v0.1.0

• Initial release
• Basic product management tools
• Order management functionality
• Category and user tools
• Sales statistics support