MCP Salesforce Example

🚀 Salesforce MCP Example Integration

This project provides a basic example of integrating with Salesforce using the Model Context Protocol (MCP). It allows users to interact with Salesforce features, such as sending emails and deploying Apex code, through MCP tools.

🚀 Quick Start

✨ Features

• Integrate with Salesforce using the Model Context Protocol (MCP).
• Interact with Salesforce features like sending emails and deploying Apex code.

📦 Installation

Prerequisites

• Node.js and npm (or yarn) are installed.
• A user capable of creating a connected app is configured in your Salesforce organization.

Setup Steps

1. Install dependencies:

npm install
# or
yarn install

2. Configure Salesforce credentials:

• You must create a file named credentials.js in the utils folder (path: ./utils/credentials.js).
• This file needs to export a function getSalesforceCredentials() that returns the Salesforce connection details for JWT Bearer Flow authentication.
• Important: Ensure that a Connected App is configured in Salesforce, with appropriate scopes enabled and relevant user profiles pre - authorized.

Example of utils/credentials.js:

import fs from 'fs';
import path from 'path';
// You may load this information from environment variables, configuration files, etc.

export function getSalesforceCredentials() {
    // --- Implement your logic here to securely load credentials ---
    const loginUrl = "YOUR_SALESFORCE_LOGIN_URL"; // e.g., https://login.salesforce.com or https://yourdomain.my.salesforce.com
    const username = "YOUR_SALESFORCE_USERNAME";
    const clientId = "YOUR_CONNECTED_APP_CONSUMER_KEY";
    // Load the private key for JWT assertion signing
    // Ensure the key format is correct, including the BEGIN/END lines.
    const privateKey = fs.readFileSync(path.resolve(__dirname, 'path/to/your/server.key'), 'utf8'); 
    // Example: const privateKey = process.env.SF_PRIVATE_KEY;

    if (!loginUrl || !username || !clientId || !privateKey) {
         throw new Error("Salesforce credentials are missing in utils/credentials.js");
    }

    return {
        loginUrl,
        username,
        clientId,
        privateKey
    };
}

3. Configuration file:

• This repository contains an example configuration file named claude_desktop_config.json for configuring your MCP server.
• Update the paths and credentials in this file according to your environment settings.

💻 Usage Examples

Basic Usage

To run the server:

node server.js

📚 Documentation

Example Demonstration

• Example video
• Higher-quality video