SFCC MCP Server
About
# SFCC MCP Server A Model Context Protocol (MCP) server for interacting with Salesforce Commerce Cloud (SFCC) APIs. ## Features - Dynamic endpoint registration based on `endpoints.json` configuration - Automatic handling of path and query parameters - Support for both GET and POST requests - OCAPI authentication using…
Explore
- Dynamic endpoint registration based on endpoints.json configuration
- Automatic handling of path and query parameters
- Support for both GET and POST requests
- OCAPI authentication using client credentials flow
- Support for SFCC Data API endpoints, including product search
- Remote mode: HTTP-based server with OAuth authentication
- Per-session configuration: Each session can use different SFCC credentials and API endpoints
- Multi-tenant support: Multiple clients can connect to different SFCC instances simultaneously
- Automated deployment: GitHub Actions integration for Google App Engine deployment
- Version management: Automated versioning and deployment workflows
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
SFCC MCP ServerCommand (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
npm install
SFCC_API_BASE=https://your-instance.api.commercecloud.salesforce.com/
To use the SFCC Data APIs, you need to configure an API client in SFCC with the proper permissions:
1. Open Command Palette (Ctrl/Cmd + Shift + P)
2. Type "MCP" and choose MCP: Add Server...
3. Choose Command (stdio) Manual Install
4. Type node <full-path-to-your>/build/index.js for the command (replace path placeholder before submit)
5. Name the MCP (e.g., "sfcc")
6. Choose to configure for User or Workspace
This will create a new server definition either in your user settings.json or in workspace .vscode/mcp.json
{
"servers": {
"sfcc": {
"type": "stdio",
"command": "node",
"args": [
"<full-path-to-your>/build/index.js"
]
}
}
}
Now you can monitor/start/restart/stop your server through MCP: List Servers command. Work with tools by switching to Agent mode in GitHub Copilot Chat
Endpoints are configured in src/endpoints.json. Each endpoint has the following structure:
{
"path": "/your/endpoint/{param}",
"description": "Description of what this endpoint does",
"method": "GET", // Optional: HTTP method (GET, POST, PUT, DELETE). Defaults to GET
"params": [
{
"name": "param",
"description": "Description of the parameter",
"type": "string",
"required": true
}
]
}
- path: The API endpoint path, with path parameters in curly braces
- description: A description of what the endpoint does
- method: HTTP method to use (GET, POST, PUT, DELETE). Defaults to GET if not specified
- params: Array of parameter definitions
- name: Parameter name
- description: Parameter description
- type: Parameter type (string, number, boolean)
- required: Whether the parameter is required
Parameters that appear in the path (e.g., {param}) are used for path substitution. Other parameters are automatically added as query parameters.
The SFCC MCP Server supports automated deployment to Google App Engine.
Tool names are automatically generated from endpoint paths:
- Path separators are replaced with underscores
- Path parameters are replaced with "by_param"
- Names are truncated to 64 characters if needed
- Uniqueness is ensured with numeric suffixes if needed
Example: /catalogs/{id}/products becomes catalogs_by_id_products
You can also specify a custom tool name in your endpoint configuration:
{
"path": "/product_search",
"toolName": "product_search",
"description": "Search for products..."
}
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"sfcc mcp server": {
"sfcc-mcp-server": {
"command": "node",
"args": [
"build/index.js"
]
}
}
}
}McpServers
{
"sfcc-mcp-server": {
"command": "node",
"args": [
"build/index.js"
]
}
}A Model Context Protocol (MCP) server for interacting with Salesforce Commerce Cloud (SFCC) APIs.
Features
- Dynamic endpoint registration based on endpoints.json configuration
- Automatic handling of path and query parameters
- Support for both GET and POST requests
- OCAPI authentication using client credentials flow
- Support for SFCC Data API endpoints, including product search
- Remote mode: HTTP-based server with OAuth authentication
- Per-session configuration: Each session can use different SFCC credentials and API endpoints
- Multi-tenant support: Multiple clients can connect to different SFCC instances simultaneously
- Automated deployment: GitHub Actions integration for Google App Engine deployment
- Version management: Automated versioning and deployment workflows
Installation
```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.
