返回 MCP 目录
public公开dns本地运行

mcp-salesforce-example

这是一个Salesforce集成示例项目,展示了如何使用Model Context Protocol (MCP)与Salesforce进行交互,包括发送邮件和部署Apex代码等功能。

article

README

🚀 Salesforce MCP 示例集成

本项目提供了一个基础示例,展示如何运用模型上下文协议(MCP)与 Salesforce 进行集成。借助 MCP 工具,用户能够与 Salesforce 的功能进行交互,例如发送电子邮件以及部署 Apex 代码。

🚀 快速开始

先决条件

  • 已安装 Node.js 和 npm(或 yarn)。
  • 在 Salesforce 组织中配置了一个可用于创建连接应用的用户。

设置

  1. 安装依赖

    npm install
    # 或者
    yarn install
    
  2. 配置 Salesforce 凭证

    • 您需要在 utils 文件夹内创建一个名为 credentials.js 的文件(路径为 ./utils/credentials.js)。
    • 此文件需导出一个函数 getSalesforceCredentials(),该函数返回用于 JWT Bearer Flow 身份验证的 Salesforce 连接详细信息。

    ⚠️ 重要提示

    请确保在 Salesforce 中配置了一个连接应用,并启用了适当的范围和预先授权了相关的用户配置文件。

    utils/credentials.js 示例

    import fs from 'fs';
    import path from 'path';
    // 您可能从环境变量、配置文件等加载这些信息
    
    export function getSalesforceCredentials() {
        // --- 在此处实现您的逻辑以安全加载凭证 ---
        const loginUrl = "YOUR_SALESFORCE_LOGIN_URL"; // 例如,https://login.salesforce.com 或 https://yourdomain.my.salesforce.com
        const username = "YOUR_SALESFORCE_USERNAME";
        const clientId = "YOUR_CONNECTED_APP_CONSUMER_KEY";
        // 加载用于 JWT 断言签名的私钥
        // 确保密钥格式正确,包括 BEGIN/END 行。
        const privateKey = fs.readFileSync(path.resolve(__dirname, 'path/to/your/server.key'), 'utf8'); 
        // 示例:const privateKey = process.env.SF_PRIVATE_KEY;
    
        if (!loginUrl || !username || !clientId || !privateKey) {
             throw new Error("在 utils/credentials.js 中缺少了 Salesforce 凭证");
        }
    
        return {
            loginUrl,
            username,
            clientId,
            privateKey
        };
    }
    
  3. 配置文件

    • 此存储库包含一个名为 claude_desktop_config.json 的示例配置文件,可用于配置您的 MCP 服务器。
    • 请根据您的环境设置更新此文件中的路径和凭证。

运行服务器

node server.js

示例演示

  • 示例演示链接:https://github.com/user-attachments/assets/08c8015a-bc57-4c5e-9f3d-4a9d9d310f4c
  • 更高质量的视频
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端