Sfcc MCP Server

🚀 SFCC MCP 服務器

SFCC MCP 服務器是一個用於與 Salesforce 商業雲（SFCC）API 交互的模型上下文協議（MCP）服務器，它能幫助開發者更便捷地與 SFCC API 進行通信，實現數據的交互與管理。

🚀 快速開始

安裝

# 安裝依賴
npm install

# 構建服務器
npm run build

配置

在項目根目錄中創建一個 .env 文件，並添加以下變量：

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

# 管理 API 憑證（客戶憑證流程）
SFCC_ADMIN_CLIENT_ID=your_admin_client_id
SFCC_ADMIN_CLIENT_SECRET=your_admin_client_secret

啟動服務器

node build/index.js

✨ 主要特性

• 基於 endpoints.json 配置文件實現端點的動態註冊，可靈活配置不同的 API 端點。
• 自動處理路徑和查詢參數，簡化 API 請求的處理過程。
• 使用客戶憑證流程進行 OCAPI 身份驗證，保障 API 訪問的安全性。
• 支持所有 SFCC GET 數據 API 端點，滿足多樣化的數據獲取需求。

📦 安裝指南

# 安裝依賴
npm install

# 構建服務器
npm run build

📚 詳細文檔

OCAPI 配置

要使用 SFCC 數據 API，需要在 SFCC 中配置一個帶有適當權限的 API 客戶端：

API 客戶端

1. 在 SFCC 賬號管理器中，轉到 API 客戶端。
2. 創建新的 API 客戶端或編輯現有客戶端。
3. 配置 OAuth 設置：
   • OAuth 客戶端 ID：(你的客戶端 ID)
   • OAuth 客戶端密鑰：(你的客戶端密鑰)
   • 默認作用域：包含所需的範圍
   • 令牌端點身份驗證方法：client_secret_post
4. 配置 API 客戶端角色：分配適當的權限以訪問所需的數據。

業務經理

1. 在 SFCC 業務經理中，轉到管理 > 站點開發 > 開放式商業 API 設置。
2. 參考 ocapi-bm-config.json 查看配置示例。

MCP 配置（針對 VSCode）

1. 打開命令 palette (Ctrl/Cmd + Shift + P)。
2. 輸入 "MCP" 並選擇 MCP: 添加服務器...。
3. 選擇 Command (stdio) 手動安裝。
4. 在命令字段中輸入 node <full-path-to-your>/build/index.js（在提交前替換路徑佔位符）。
5. 命名 MCP（例如："sfcc"）。
6. 選擇用戶或工作區進行配置。

這將在你的用戶 settings.json 或工作區 .vscode/mcp.json 中創建一個新的 MCP 定義：

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

現在你可以通過 MCP: 列出服務器 命令監控、啟動、重新啟動或停止服務器。使用工具時，請切換到 GitHub Copilot Chat 中的 代理 模式。

端點配置

端點在 src/endpoints.json 中配置，每個端點具有以下結構：

• 路徑：API 請求的路徑
• 描述：端點的描述信息
• 參數：包含參數名稱、類型和是否必需的信息

工具命名規則

工具名通過將路徑轉換為特定格式並截斷到 64 字符以內生成，同時使用數字後綴確保唯一性。

📄 許可證

整個項目採用 MIT 許可證，允許自由使用、修改和分發代碼。