JinDaGe - sfcc-mcp-server MCP Details

article

README

🚀 SFCC MCP 服务器

SFCC MCP 服务器是一个用于与 Salesforce 商业云 (SFCC) API 交互的模型上下文协议 (MCP) 服务器，能帮助开发者高效地与 SFCC API 进行数据交互。

✨ 主要特性

基于 endpoints.json 配置文件实现端点的动态注册，可灵活调整 API 端点。
自动处理路径和查询参数，简化参数处理流程。
使用客户凭证流程进行 OCAPI 身份验证，保障数据交互的安全性。
支持所有 SFCC GET 数据 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

OCAPI 配置

要使用 SFCC 数据 API，需要在 SFCC 中配置一个带有适当权限的 API 客户端：

API 客户端

在 SFCC 账号管理器中，转到 API 客户端。
创建新的 API 客户端或编辑现有客户端。
配置 OAuth 设置：
- OAuth 客户端 ID：(你的客户端 ID)
- OAuth 客户端密钥：(你的客户端密钥)
- 默认作用域：包含所需的范围。
- 令牌端点身份验证方法：client_secret_post
配置 API 客户端角色：分配适当的权限以访问所需的数据。

业务经理

在 SFCC 业务经理中，转到管理 > 站点开发 > 开放式商业 API 设置。
参考 ocapi-bm-config.json 查看配置示例。

MCP 配置（针对 VSCode）

打开命令面板 (Ctrl/Cmd + Shift + P)。
输入 "MCP" 并选择 MCP: 添加服务器...。
选择 Command (stdio) 手动安装。
在命令字段中输入 node <full-path-to-your>/build/index.js（在提交前替换路径占位符）。
命名 MCP（例如："sfcc"）。
选择用户或工作区进行配置。

这将在你的用户 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 字符以内生成，同时使用数字后缀确保唯一性。

💻 使用示例

基础用法

启动服务器：

node build/index.js

📄 许可证

整个项目采用 MIT 许可证，允许自由使用、修改和分发代码。

sfcc-mcp-server