Salesforce MCP Server

Salesforce MCP Server

site icon
2025.04.24 0
PythonSalesforce集成自然语言处理数据管理开发效率数据库
Salesforce MCP Server 是一个基于 Model Context Protocol (MCP) 的服务实现,它集成了 Claude/VS Code 与 Salesforce,使用户能够通过自然语言与 Salesforce 数据和元数据进行交互。该服务允许 Claude/Github Copilot 通过日常语言查询、修改和管理 Salesforce 对象和记录。
View on GitHub

Overview

基本能力

产品定位

Salesforce MCP Server 是一个连接自然语言处理工具(如 Claude/Github Copilot)与 Salesforce 平台的中间件,旨在提升开发者和业务用户与 Salesforce 数据交互的效率。

核心功能

  • 智能对象搜索:支持通过部分名称匹配查找 Salesforce 对象
  • 详细模式信息:获取任何对象的完整字段和关系详情
  • 灵活数据查询:支持关系查询和复杂过滤条件的记录查询
  • 选项列表值检索:获取任何选项列表字段的所有可能值
  • 字段类型过滤:跨对象查找特定类型的字段
  • 关系探索:分析对象间的父子关系
  • 增强API元数据:通过直接API调用访问完整对象元数据
  • 调试日志管理:配置和检索Salesforce用户的调试日志
  • 验证规则管理:获取对象上验证规则的详细信息

适用场景

  • 开发者快速查询和操作Salesforce数据
  • 业务用户通过自然语言获取Salesforce信息
  • 自动化Salesforce数据管理流程
  • 调试和监控Salesforce应用

工具列表

工具名称 描述
search_objects 通过部分名称匹配搜索标准或自定义对象
describe_object 获取Salesforce对象的详细模式信息
describe_object_with_api 使用直接REST API调用获取扩展对象元数据
describe_relationship_fields 探索对象间的父子关系
query_records 支持关系和过滤器的记录查询
get_fields_by_type 查找对象中特定数据类型的字段
get_picklist_values 检索选项列表字段的所有值
get_validation_rules 获取对象上验证规则的详细信息
manage_debug_logs 配置和检索用户的调试日志

常见问题解答

  • 需要Docker环境运行服务
  • 需要Salesforce OAuth2凭证进行认证
  • 配置信息可以存储在VS Code用户设置或工作区.mcp.json文件中

使用教程

使用依赖

  1. 安装Docker: Docker安装指南
  2. 确保Docker正在运行
  3. 拉取Docker镜像:
docker pull suraj20028/salesforce-mcp-server
  1. 准备Salesforce OAuth2凭证:
  2. 客户端ID
  3. 客户端密钥
  4. 用户名
  5. 密码

安装教程

  1. 在VS Code中打开用户设置(JSON)
  2. 添加以下配置:
"mcp": {
  "inputs": [
    {
      "type": "promptString",
      "id": "client_id",
      "description": "Salesforce Client ID",
      "password": false
    },
    {
      "type": "promptString",
      "id": "client_secret",
      "description": "Salesforce Client Secret",
      "password": false
    },
    {
      "type": "promptString",
      "id": "username",
      "description": "Salesforce Username",
      "password": false
    },
    {
      "type": "promptString",
      "id": "password",
      "description": "Salesforce Password",
      "password": false
    }
  ],
  "servers": {
    "salesforce": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "SALESFORCE_CLIENT_ID",
        "-e", "SALESFORCE_CLIENT_SECRET",
        "-e", "SALESFORCE_USERNAME",
        "-e", "SALESFORCE_PASSWORD",
        "suraj20028/salesforce-mcp-server"
      ],
      "env": {
        "SALESFORCE_CLIENT_ID": "${input:client_id}",
        "SALESFORCE_CLIENT_SECRET": "${input:client_secret}",
        "SALESFORCE_USERNAME": "${input:username}",
        "SALESFORCE_PASSWORD": "${input:password}"
      }
    }
  }
}

调试方式

  1. 确保Docker容器正常运行
  2. 在VS Code中使用MCP工具测试功能
  3. 检查日志输出是否有错误信息
  4. 验证Salesforce连接是否成功建立

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。