Skip to content

πŸ€– An MCP server that helps connect your AI applications with your Salesforce Commerce Cloud instance

License

Notifications You must be signed in to change notification settings

brinzl/commercecloud-mcp-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ›οΈ Commerce Cloud MCP Server

A server that helps connect your AI applications with Salesforce Commerce Cloud. It uses the Model Context Protocol (MCP) to make data exchange between your AI client application and Commerce Cloud instance.

✨ Features

  • πŸ›οΈ Product management and updates
  • πŸ“Š Order analysis and insights
  • πŸ—‚οΈ Custom object operations
  • πŸ“„ Content asset management
  • βš™οΈ Environment-based configuration

πŸ”„ Flow Diagram

Flow Diagram

πŸš€ Setup Instructions

Prerequisites

  • Node.js version 22 or higher
  • Git
  • A Salesforce Commerce Cloud instance with OCAPI access
  • An MCP client application (like Claude Desktop App)

Installation Steps

  1. Clone the repository:
git clone https://github.com/your-username/commercecloud-mcp-server.git
cd commercecloud-mcp-server
  1. Install dependencies:
npm install
  1. Create and configure your environment file:
cp .env.example .env

Edit the .env file with your Salesforce Commerce Cloud credentials.

  1. Build the project:
npm run build
  1. Import OCAPI configurations:

    The OCAPI configuration files are located in the data/ocapi directory. Import them into your SFCC Business Manager:

    • Log into Business Manager
    • Navigate to Administration > Site Development > Open Commerce API Settings
    • For each JSON file in the data/ocapi directory:
      • Select the appropriate API type (Shop/Data)
      • Copy the contents of the JSON file
      • Paste into the configuration field
      • Click "Save"

    These configurations enable the necessary endpoints for the MCP server to function.

  2. Configure your MCP client application (Example - Claude Desktop App):

    • Open Claude Desktop App
    • Go to File > Settings > Developer > Edit Config
    • This will open a folder containing a file claude_desktop_config.json
    • Open the file in an editor and add the server details:
{
  "mcpServers": {
    "commercecloud": {
      "command": "node",
      "args": ["/ABSOLUTE/PATH/TO/commercecloud-mcp-server/dist/index.js"]
    }
  }
}

Note: Replace /ABSOLUTE/PATH/TO/ with the actual path to your project folder.

πŸ“‹ Use Cases

Use Case Name Description Implementation Status
Product Details Fetch product information from Commerce Cloud βœ… Supported Now
Product Updates Generate product descriptions from images and update product details automatically βœ… Supported Now
Order Details Analyze order patterns and get insights about customer purchase behavior βœ… Supported Now
Custom Objects Read, Write, and Create custom objects βœ… Supported Now
Content Assets Fetch content assets from Commerce Cloud βœ… Supported Now
Content Updates Generate content body from design images and update content assets automatically βœ… Supported Now
Site Preferences Manage site-specific configurations and preferences πŸ”„ Future Implementation
Promotions & Campaign Manage promotions and campaigns πŸ”„ Future Implementation
Job Configurations Manage job configurations πŸ”„ Future Implementation

πŸ“š Supporting Documentation

πŸ“„ License

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

πŸ‘₯ Credits

Greater minds than mine are behind creating tools that made this project possible. I would like to mention those projects

I hope you find this tool useful! 🌟

Made with ❀️ by Brinsil.

About

πŸ€– An MCP server that helps connect your AI applications with your Salesforce Commerce Cloud instance

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •