使用说明

项目简介

Salesforce MCP Connector 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在桥接大型语言模型 (LLM) 和 Salesforce 平台。它允许 LLM 通过标准化的 MCP 协议，安全地访问和操作 Salesforce 中的数据，从而实现更智能的 Salesforce 应用集成。

主要功能点

数据查询: 支持使用 SOQL (Salesforce Object Query Language) 查询 Salesforce 数据。
数据搜索: 支持使用 SOSL (Salesforce Object Search Language) 搜索 Salesforce 数据。
元数据获取: 检索 Salesforce 对象的字段信息，包括字段名、标签和类型。
记录管理: 支持 Salesforce 记录的创建、读取、更新和删除 (CRUD) 操作。
高级API: 允许执行 Salesforce Tooling API 请求和 Apex REST 请求，扩展 Salesforce 功能。
REST API 调用: 支持直接调用 Salesforce REST API，提供灵活的集成能力。

安装步骤

环境准备: 确保已安装 Python 和 pip。建议使用 Python 3.8 或更高版本。

下载仓库: 克隆 GitHub 仓库到本地：

git clone https://github.com/smn2gnt/MCP-Salesforce

进入目录: 进入仓库目录：
```
cd MCP-Salesforce
```
安装依赖: 安装项目依赖的 Python 包：
```
pip install .
```

服务器配置

本MCP服务器需要配置 Salesforce 连接信息，包括用户名、密码和安全令牌。
对于 MCP 客户端，需要在客户端的配置文件中指定服务器的启动方式。以 'claude_desktop_config.json' 为例，配置示例如下：

{
    "serverName": "salesforce",
    "command": "uvx",
    "args": [
        "--from",
        "mcp-salesforce-connector",
        "salesforce"
    ],
    "env": {
        "SALESFORCE_USERNAME": "YOUR_SALESFORCE_USERNAME",  // 替换为您的 Salesforce 用户名
        "SALESFORCE_PASSWORD": "YOUR_SALESFORCE_PASSWORD",  // 替换为您的 Salesforce 密码
        "SALESFORCE_SECURITY_TOKEN": "YOUR_SALESFORCE_SECURITY_TOKEN" // 替换为您的 Salesforce 安全令牌
    }
}

配置参数说明: - 'serverName': 服务器名称，客户端用此名称标识和调用该服务器，例如 "salesforce"。 - 'command': 启动服务器的命令，这里使用 'uvx'，可能需要根据实际运行环境调整。 - 'args': 传递给 'command' 的参数，'--from mcp-salesforce-connector salesforce' 指定了运行的入口点。 - 'env': 环境变量配置，用于传递 Salesforce 连接凭据。 - 'SALESFORCE_USERNAME': 您的 Salesforce 用户名。 - 'SALESFORCE_PASSWORD': 您的 Salesforce 密码。 - 'SALESFORCE_SECURITY_TOKEN': 您的 Salesforce 安全令牌。 请务必妥善保管安全令牌，避免泄露。

基本使用方法

启动服务器: MCP 服务器通常由 MCP 客户端（如 Claude）自动启动。配置完成后，当客户端需要与 Salesforce 交互时，会自动启动该服务器。如果需要手动启动测试，请参考 MCP 客户端的文档或仓库说明。根据 'README.md' 和配置，推测可以使用 'uvx run salesforce' 命令启动服务器 (需要 'uvx' 环境支持).
客户端交互: 在支持 MCP 协议的 LLM 客户端中，配置并连接该 Salesforce MCP 服务器后，即可通过自然语言指令，指示 LLM 使用 Salesforce 数据。例如，您可以向 LLM 提问 "查询 Salesforce 中最近创建的 10 个客户" 或 "获取名为 'Acme' 的客户信息"。
工具调用: 服务器提供了多种工具 (Tools)，例如 'run_soql_query', 'run_sosl_search', 'get_object_fields' 等。LLM 客户端会根据用户指令，选择合适的工具，并传递参数与服务器交互，最终获取 Salesforce 数据并返回给用户。

关键词