SFCC MCP 服务器

用于与 Salesforce Commerce Cloud (SFCC) API 交互的模型上下文协议 (MCP) 服务器。

功能特性

• 基于 endpoints.json 配置的动态端点注册
• 自动处理路径和查询参数
• 使用客户端凭据流程的 OCAPI 身份验证
• 支持所有 SFCC GET Data API 端点

安装

# 安装依赖
npm install

# 构建服务器
npm run build

配置

在项目根目录下创建一个 .env 文件，并包含以下变量：

# SFCC API 配置
SFCC_API_BASE=https://your-instance.api.commercecloud.salesforce.com/
SFCC_SITE_ID=your_site_id  # 可选，默认为 "RefArch"

# 管理 API 凭据（客户端凭据流程）
SFCC_ADMIN_CLIENT_ID=your_admin_client_id
SFCC_ADMIN_CLIENT_SECRET=your_admin_client_secret

OCAPI 配置

要使用 SFCC Data API，您需要在 SFCC 中配置一个具有适当权限的 API 客户端：

1. 在 SFCC Business Manager 中，转到 Administration > Site Development > Open Commerce API Settings
2. 创建一个新的 API 客户端或编辑现有的客户端
3. 配置 OAuth 设置：
   • OAuth Client ID: (您的客户端 ID)
   • OAuth Client Secret: (您的客户端密钥)
   • Default scopes: 包括您的端点所需的范围
   • Token Endpoint Auth Method: client_secret_post
4. 配置 API 客户端角色：
   • 分配适当的角色以访问所需的数据

使用

启动服务器：

node build/index.js

端点配置

端点在 src/endpoints.json 中配置。 每个端点具有以下结构：

{
    "path": "/your/endpoint/{param}",
    "description": "此端点功能的描述",
    "params": [
        {
            "name": "param",
            "description": "参数的描述",
            "type": "string",
            "required": true
        }
    ]
}

• path: API 端点路径，路径参数用花括号括起来
• description: 端点功能的描述
• params: 参数定义数组
  • name: 参数名称
  • description: 参数描述
  • type: 参数类型（目前仅支持字符串）
  • required: 参数是否必需

出现在路径中的参数（例如，{param}）用于路径替换。 其他参数会自动添加为查询参数。

工具名称

工具名称从端点路径自动生成：

• 路径分隔符替换为下划线
• 路径参数替换为 "by_param"
• 名称如果需要，会被截断为 64 个字符
• 如果需要，使用数字后缀确保唯一性

示例：/catalogs/{id}/products 变为 catalogs_by_id_products

许可证

MIT