Sfcc MCP Server

🚀 SFCC MCP Server

A Model Context Protocol (MCP) server for interacting with the Salesforce Commerce Cloud (SFCC) API.

🚀 Quick Start

The SFCC MCP Server is designed to facilitate seamless interaction with the Salesforce Commerce Cloud API. It offers dynamic endpoint registration, automatic parameter handling, and secure authentication.

✨ Features

• Dynamically register endpoints based on the endpoints.json configuration file.
• Automatically handle path and query parameters.
• Use the client credentials flow for OCAPI authentication.
• Support all SFCC GET data API endpoints.

📦 Installation

# Install dependencies
npm install

# Build the server
npm run build

🛠️ Configuration

Create a .env file in the project root directory and add the following variables:

# SFCC API configuration
SFCC_API_BASE=https://your-instance.api.commercecloud.salesforce.com/

# Admin API credentials (client credentials flow)
SFCC_ADMIN_CLIENT_ID=your_admin_client_id
SFCC_ADMIN_CLIENT_SECRET=your_admin_client_secret

🛠️ OCAPI Configuration

To use the SFCC data API, you need to configure an API client with appropriate permissions in SFCC:

API Client

1. In the SFCC Account Manager, go to API Clients.
2. Create a new API client or edit an existing one.
3. Configure the OAuth settings:
   • OAuth Client ID: (Your client ID)
   • OAuth Client Secret: (Your client secret)
   • Default Scopes: Include the required scopes.
   • Token Endpoint Authentication Method: client_secret_post
4. Configure the API client roles:
   • Assign appropriate permissions to access the required data.

Business Manager

1. In the SFCC Business Manager, go to Administration > Site Development > Open Commerce API Settings.
2. Refer to ocapi-bm-config.json for a configuration example.

🛠️ MCP Configuration (for VSCode)

1. Open the command palette (Ctrl/Cmd + Shift + P).
2. Type "MCP" and select MCP: Add Server....
3. Choose Command (stdio) Manual Installation.
4. Enter node <full-path-to-your>/build/index.js in the command field (replace the path placeholder before committing).
5. Name the MCP (e.g., "sfcc").
6. Choose the user or workspace for configuration.

This will create a new MCP definition in your user settings.json or workspace .vscode/mcp.json:

{
    "servers": {
        "sfcc": {
            "type": "stdio",
            "command": "node",
            "args": [
                "<full-path-to-your>/build/index.js"
            ]
        }
    }
}

Now you can monitor, start, restart, or stop the server using the MCP: List Servers command. When using the tool, switch to the Proxy mode in GitHub Copilot Chat.

💻 Usage Examples

Basic Usage

Start the server:

node build/index.js

📚 Documentation

Endpoint Configuration

Endpoints are configured in src/endpoints.json, and each endpoint has the following structure:

• Path: The path for the API request.
• Description: Descriptive information about the endpoint.
• Parameters: Information including parameter names, types, and whether they are required.

Tool Naming Rules

Tool names are generated by converting the path to a specific format and truncating it to within 64 characters, while using numerical suffixes to ensure uniqueness.

📄 License

The entire project is licensed under the MIT License, allowing for free use, modification, and distribution of the code.