Salesforce MCP Server 使用说明

项目简介

Salesforce MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在为大型语言模型 (LLM) 应用提供与 Salesforce 平台集成的能力。通过此服务器，LLM 应用可以安全、可控地访问和操作 Salesforce 数据，从而实现更智能的 CRM 交互和自动化工作流程。

主要功能点

执行 SOQL 查询: 允许 LLM 应用通过发送 SOQL 查询来检索 Salesforce 中的数据。
获取对象元数据: 提供 Salesforce 对象的详细元数据信息，帮助 LLM 应用理解数据结构。
数据 CRUD 操作: 支持创建、更新和删除 Salesforce 记录，使 LLM 应用能够进行数据管理。
工具化访问: 以工具的形式暴露 Salesforce 功能，方便 LLM 应用按需调用。
安全认证处理: 服务器负责处理 Salesforce 的安全认证，保障数据访问安全。

安装步骤

克隆仓库: 将 GitHub 仓库 'https://github.com/kablewy/salesforce-mcp-server' 克隆到本地。
配置环境变量:
- 复制 '.env.example' 文件并重命名为 '.env'。
- 在 '.env' 文件中填入您的 Salesforce 组织的用户名 (SF_USERNAME)、密码 (SF_PASSWORD) 和安全令牌 (SF_SECURITY_TOKEN)。
- 确保已安装 Node.js 和 npm。
安装依赖: 在仓库根目录下运行 'npm install' 命令安装项目依赖。
构建项目: 运行 'npm run build' 命令编译 TypeScript 代码。
启动服务器: 运行 'npm start' 命令启动 Salesforce MCP Server。

服务器配置 (MCP 客户端配置)

MCP 客户端需要配置以下 JSON 信息以连接到 Salesforce MCP Server：

{
  "serverName": "salesforce-mcp-server",  // 服务器名称，用于在客户端标识
  "command": "node",                      // 启动服务器的命令，这里使用 Node.js 运行 JavaScript
  "args": [                               // 命令参数
    "dist/index.js"                     // 服务器入口文件路径，指向编译后的 index.js 文件
  ]
}

基本使用方法

启动服务器后，MCP 客户端可以通过 JSON-RPC 协议与服务器通信。客户端可以发送请求调用服务器提供的工具，例如：

执行 SOQL 查询:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "callTool",
  "params": {
    "name": "query",
    "arguments": {
      "query": "SELECT Id, Name FROM Account WHERE Industry = 'Technology' LIMIT 10"
    }
  }
}

获取 Account 对象的元数据:

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "callTool",
  "params": {
    "name": "describe-object",
    "arguments": {
      "objectName": "Account"
    }
  }
}

请参考仓库 README.md 文件和代码了解更多工具和使用细节。

关键词