关键词

SalesforceAI集成开发工具数据访问元数据管理

项目简介

Salesforce MCP 服务器是一个基于 Model Context Protocol (MCP) 实现的后端应用，旨在将 Salesforce 的功能和数据以标准化的方式暴露给兼容 MCP 的 LLM 客户端（如 Claude Desktop, Cline）。它允许 AI 工具访问 Salesforce 资源、执行操作和获取上下文信息，从而实现更智能、更高效的 Salesforce 相关开发和数据管理。

主要功能点

该服务器提供了一系列全面的工具，涵盖 Salesforce 集成的多个方面：

  • 查询与搜索: 执行 SOQL 查询（支持自动批量处理和分页）和 SOSL 搜索。
  • Apex 开发: 执行匿名 Apex 代码、运行 Apex 测试（含覆盖率报告）、获取调试日志。
  • 数据管理: 对记录进行创建、读取、更新、删除和 upsert（插入或更新）操作，支持单条或批量处理。
  • 元数据操作: 列出、检索和部署特定的元数据组件（如 Apex 类、自定义对象、字段等）。
  • 连接管理: 测试和监控与 Salesforce 组织的连接状态。

此外，项目还具备自动批量 API 选择、OAuth2 和用户名/密码双重认证、智能缓存、全面的日志记录等关键能力。

安装步骤

要安装和运行此 Salesforce MCP 服务器，请确保您的系统已安装 Node.js (推荐 18 或更高版本)。

  1. 克隆仓库: 
    git clone https://github.com/jaworjar95/salesforce-mcp-server.git
cd salesforce-mcp-server
  2. 安装依赖: 
    npm install
  3. 构建项目: 
    npm run build

服务器配置

该 MCP 服务器需要您的 Salesforce 凭据才能连接到组织。您可以通过创建 '.env' 文件来配置这些凭据，或直接在 MCP 客户端的配置中通过环境变量传递。

推荐方式：创建 '.env' 文件 (在项目根目录)

在 '.env' 文件中，选择以下任一认证方式配置您的凭据：

  • 方式 1: 用户名/密码认证 (推荐用于开发) 
    [email protected]
SF_PASSWORD=your-password
SF_SECURITY_TOKEN=your-security-token # 如果您的组织需要安全令牌
SF_LOGIN_URL=https://login.salesforce.com # 生产环境用此，沙箱环境用 https://test.salesforce.com
  • 方式 2: OAuth2 认证 (推荐用于生产) 
    SF_CLIENT_ID=your-oauth2-client-id
SF_CLIENT_SECRET=your-oauth2-client-secret # 如果需要
SF_REFRESH_TOKEN=your-refresh-token
SF_INSTANCE_URL=https://yourorg.my.salesforce.com # 您的组织实例 URL

您还可以配置可选参数，如 'SF_API_VERSION=63.0'。

MCP 客户端配置:

MCP 客户端（如 Claude Desktop 或 Cline VS Code 插件）需要知道如何启动这个 MCP 服务器。通常，您需要在客户端的 MCP 设置中添加一个新的服务器配置。配置信息一般是 JSON 格式，至少包含以下关键部分：

  • 'name': 服务器的名称（例如 "salesforce"）。
  • 'command': 用于启动服务器的可执行文件或命令。对于这个 Node.js 项目，通常是 'node'。
  • 'args': 传递给 'command' 的参数。用于启动服务器主文件，例如 '["path/to/salesforce-mcp-server/build/index.js"]'。'path/to/salesforce-mcp-server' 应替换为您实际的项目路径。
  • 'env': 可选，用于设置服务器运行时的环境变量。如果未在 '.env' 文件中配置凭据，可以在此处设置 'SF_USERNAME', 'SF_PASSWORD', 'SF_SECURITY_TOKEN' 或 'SF_CLIENT_ID', 'SF_REFRESH_TOKEN' 等环境变量。

具体的配置位置和格式请参考您使用的 MCP 客户端的文档。

基本使用方法

  1. 确保您已完成安装和服务器配置步骤。
  2. 启动您的 MCP 兼容客户端（例如 Claude Desktop 或打开配置了 Cline 插件的 VS Code）。
  3. 客户端应该会自动检测并启动配置好的 Salesforce MCP 服务器。
  4. 在客户端的 AI 对话界面中，当您发起需要 Salesforce 上下文或操作的请求时，AI 模型将能够通过配置的 MCP 服务器调用相应的工具（如执行 SOQL 查询、创建记录等），并将结果返回给您。

请注意，某些敏感操作（如数据修改、元数据部署、代码执行）可能需要在客户端中进行手动确认。

信息

分类

商业系统

访问项目