关键词

SalesforceSOQLCRM数据查询工具集成

使用说明

项目简介

Salesforce MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在作为大型语言模型 (LLM) 与 Salesforce 平台之间的桥梁。它允许LLM应用通过标准化的MCP协议，安全地访问和操作Salesforce中的数据。该服务器利用 jsforce 库与 Salesforce REST API 进行通信，实现对Salesforce数据的查询、描述等操作。

主要功能点

  • SOQL 查询执行: 支持执行 Salesforce Object Query Language (SOQL) 查询，从Salesforce中检索数据。
  • 对象元数据检索: 能够获取 Salesforce 对象的元数据信息，例如字段、关系等。
  • 工具集成: 通过 MCP 协议的工具 (Tools) 功能，向 LLM 客户端暴露 Salesforce 的数据访问能力。
  • 安全认证处理: 通过环境变量安全地管理 Salesforce 认证信息。
  • 实时数据访问: 提供对 Salesforce 数据的实时访问能力。

安装步骤

  1. 克隆仓库: 在你的本地环境中克隆 GitHub 仓库 'https://github.com/MCP-Mirror/kablewy_salesforce-mcp-server'。 
    git clone https://github.com/MCP-Mirror/kablewy_salesforce-mcp-server.git
cd kablewy_salesforce-mcp-server
  2. 配置环境变量: 复制 '.env.example' 文件为 '.env'，并根据你的 Salesforce 组织信息填写以下环境变量： 
    SF_LOGIN_URL=https://login.salesforce.com  # 或你的 Salesforce 登录 URL，例如：https://[your-domain].salesforce.com
SF_USERNAME=你的Salesforce用户名
SF_PASSWORD=你的Salesforce密码
SF_SECURITY_TOKEN=你的Salesforce安全令牌

    注意: 请务必妥善保管 '.env' 文件，避免泄露敏感信息。

  3. 安装依赖: 在项目根目录下运行 npm 命令安装项目依赖。 
    npm install
  4. 构建项目: 运行 npm 命令构建项目。 
    npm run build

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接 Salesforce MCP Server。客户端需要配置 'command' 和 'args' 以启动服务器。

{
  "serverName": "salesforce-mcp-server",
  "command": "node",
  "args": ["dist/index.js"]
}
  • 'serverName': 自定义的服务名称，用于在 MCP 客户端中标识该服务器。
  • 'command': 启动服务器的命令，这里使用 'node' 运行 Node.js 程序。
  • 'args': 命令参数数组，指向编译后的服务器入口文件 'dist/index.js'。

基本使用方法

  1. 启动服务器: 在项目根目录下运行以下命令启动 Salesforce MCP Server。

    npm start

    服务器成功启动后，会在控制台输出 'Salesforce MCP server running on stdio'。

  2. MCP 客户端交互: 配置并启动 MCP 客户端，客户端将通过 Stdio 与 Salesforce MCP Server 进行通信。客户端可以使用以下工具 (Tools) 向服务器发送请求：

    • query: 执行 SOQL 查询。

      {
  "jsonrpc": "2.0",
  "method": "CallTool",
  "params": {
    "name": "query",
    "arguments": {
      "query": "SELECT Id, Name FROM Account LIMIT 10"
    }
  },
  "id": "1"
}

    • describe-object: 获取 Salesforce 对象元数据。

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

    MCP 服务器将处理这些请求，并返回 JSON-RPC 响应到客户端，包含查询结果或对象元数据。

信息

分类

商业系统

访问项目