Salesforce MCP Server

by jaworjar95

42 stars
455 downloads
Not rated
GitHub Website

About

Salesforce integration using OAuth2. Write operations disabled by default per integration. 700+ tools covering SOQL, SOSL, REST, and CRUD, individually selectable. Requires a DataGrout account.

Details

Author
jaworjar95
GitHub stars
42
Downloads
455
Categories
Developer Tools, Other, Security, Search

Jump to

- 17 comprehensive tools for Salesforce operations
- Auto-bulk switching for optimal performance
- Dual authentication: OAuth2 and Username/Password
- Intelligent caching with 1‑hour TTL for SObject metadata
- Full TypeScript implementation with runtime validation
- Raw Salesforce errors preserved for debugging

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Salesforce MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install via npx by adding the server configuration to your MCP client’s JSON settings file (e.g., Claude Desktop, Cline, or Cursor). Provide authentication using either Username/Password (with optional security token) or OAuth 2.0 credentials as environment variables. Once configured, you can invoke any of the 17 available tools, such as execute-soql, execute-apex, or deploy-metadata.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "salesforce mcp server": {
            "salesforce": {
                "command": "npx",
                "args": [
                    "-y",
                    "@jjar/salesforce-mcp-server"
                ],
                "env": {
                    "SF_USERNAME": "your-username@company.com",
                    "SF_PASSWORD": "your-password",
                    "SF_SECURITY_TOKEN": "",
                    "SF_LOGIN_URL": "https://login.salesforce.com"
                },
                "disabled": false,
                "alwaysAllow": [
                    "test-connection",
                    "execute-soql",
                    "describe-sobject",
                    "get-record",
                    "get-apex-logs",
                    "list-metadata-types"
                ]
            }
        }
    }
}

Mcp.servers

{
    "salesforce": {
        "command": "npx",
        "args": [
            "-y",
            "@jjar/salesforce-mcp-server"
        ],
        "env": {
            "SF_USERNAME": "your-username@company.com",
            "SF_PASSWORD": "your-password",
            "SF_SECURITY_TOKEN": "",
            "SF_LOGIN_URL": "https://login.salesforce.com"
        },
        "disabled": false,
        "alwaysAllow": [
            "test-connection",
            "execute-soql",
            "describe-sobject",
            "get-record",
            "get-apex-logs",
            "list-metadata-types"
        ]
    }
}

Salesforce MCP Server

A comprehensive Model Context Protocol (MCP) server that provides seamless Salesforce integration for AI development tools like Claude Desktop, Cline, and other MCP-compatible clients.

🚀 Features

17 Comprehensive Tools

🔍 Query & Search Tools

- execute-soql - Execute SOQL queries with auto-bulk switching and pagination - execute-sosl - Multi-object search with result aggregation - describe-sobject - SObject metadata with intelligent caching

⚡ Apex Development Tools

- execute-apex - Anonymous Apex execution with debug log capture - run-apex-tests - Apex test execution with coverage reporting - get-apex-logs - Debug log retrieval with filtering

📊 Data Management Tools

- create-record - Single/bulk record creation with auto-bulk switching - get-record - Record retrieval with field selection - update-record - Single/bulk record updates with validation - delete-record - Single/bulk record deletion - upsert-record - External ID-based upsert operations

🔧 Metadata Tools (Component-Based)

- list-metadata-types - Discover metadata types - deploy-metadata - Deploy individual metadata components (e.g., ApexClass, CustomObject) from files or JSON - deploy-bundle - Deploy a metadata bundle (e.g., LWC) from a directory path - retrieve-metadata - Retrieve individual metadata components, with an option to save to a file - check-deploy-status - Check the status of a deployment

🔗 Connection Tools

- test-connection - Connection validation and health monitoring

Key Capabilities

- 🔄 Auto-Bulk Switching - Intelligent API selection for optimal performance
- 🔐 Dual Authentication - OAuth2 and Username/Password support
- ⚡ Smart Caching - 1-hour TTL for SObject metadata
- 🛡️ Type Safety - Full TypeScript implementation with runtime validation
- 📝 Comprehensive Logging - Detailed debugging and monitoring
- 🔍 Raw Error Exposure - Preserve exact Salesforce errors for debugging

🚀 Installation

To use with Desktop APP, such as Claude Desktop, Cline, Cursor, and so on, add the MCP server config below.

On macOS / Linux systems:

<details>
<summary><strong>Username/Password Authentication</strong></summary>

{
  "mcp.servers": {
    "salesforce": {
      "command": "npx",
      "args": [
        "-y",
        "@jjar/salesforce-mcp-server"
      ],
      "env": {
        "SF_USERNAME": "your-username@company.com",
        "SF_PASSWORD": "your-password",
        "SF_SECURITY_TOKEN": "",
        "SF_LOGIN_URL": "https://login.salesforce.com"
      },
      "disabled": false,
      "alwaysAllow": [
        "test-connection",
        "execute-soql",
        "describe-sobject",
        "get-record",
        "get-apex-logs",
        "list-metadata-types"
      ]
    }
  }
}
</details>

<details>
<summary><strong>OAuth 2.0 Authentication</strong></summary>

{
  "mcp.servers": {
    "salesforce": {
      "command": "npx",
      "args": [
        "-y",
        "@jjar/salesforce-mcp-server"
      ],
      "env": {
        "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"
      },
      "disabled": false,
      "alwaysAllow": [
        "test-connection",
        "execute-soql",
        "describe-sobject",
        "get-record",
        "get-apex-logs",
        "list-metadata-types"
      ]
    }
  }
}
</details>

---

On Windows systems:

<details>
<summary><strong>Username/Password Authentication</strong></summary>

{
  "mcp.servers": {
    "salesforce": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "@jjar/salesforce-mcp-server"
      ],
      "env": {
        "SF_USERNAME": "your-username@company.com",
        "SF_PASSWORD": "your-password",
        "SF_SECURITY_TOKEN": "",
        "SF_LOGIN_URL": "https://login.salesforce.com"
      },
      "disabled": false,
      "alwaysAllow": [
        "test-connection",
        "execute-soql",
        "describe-sobject",
        "get-record",
        "get-apex-logs",
        "list-metadata-types"
      ]
    }
  }
}
</details>

<details>
<summary><strong>OAuth 2.0 Authentication</strong></summary>

{
  "mcp.servers": {
    "salesforce": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "@jjar/salesforce-mcp-server"
      ],
      "env": {
        "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"
      },
      "disabled": false,
      "alwaysAllow": [
        "test-connection",
        "execute-soql",
        "describe-sobject",
        "get-record",
        "get-apex-logs",
        "list-metadata-types"
      ]
    }
  }
}
</details>

Configuration File Locations

<details>
<summary>Claude Desktop</summary>

- Windows: %APPDATA%\Claude\claude_desktop_config.json
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

</details>

<details>
<summary>Cline (VS Code)</summary>

- Windows: %APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json
- macOS: ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
- Linux: ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

> ⚠️ Important: After adding or modifying the MCP server configuration, you must restart VS Code for the changes to take effect.

</details>

<details>
<summary>Cursor</summary>

- Windows: %USERPROFILE%\.cursor\mcp.json
- macOS: ~/.cursor/mcp.json
- Linux: ~/.cursor/mcp.json

</details>

Tool Safety Levels

✅ Safe for Auto-Approval (alwaysAllow)
- test-connection - Connection validation (read-only)
- execute-soql - SOQL queries (read-only)
- describe-sobject - Metadata inspection (read-only)
- get-record - Single record retrieval (read-only)
- get-apex-logs - Debug log access (read-only)
- list-metadata-types - Metadata type discovery (read-only)

⚠️ Requires Manual Approval
- create-record, update-record, delete-record, upsert-record - Data modification
- deploy-metadata - Metadata deployment
- execute-apex, run-apex-tests - Code execution
- execute-sosl - Search operations (can be resource-intensive)
- retrieve-metadata - Metadata retrieval (can be large)

Authentication

Username/Password Authentication

1. Obtain your security token from Salesforce Setup → Personal Information → Reset Security Token (only required if your IP is not trusted) 2. Set environment variables as shown in the configuration section 3. Use https://login.salesforce.com for production or https://test.salesforce.com for sandboxes

> 💡 Security Token: Only add the security token if Salesforce requires it for your connection. If not leave SF_SECURITY_TOKEN empty.

OAuth2 Authentication

1. Create a Connected App in Salesforce Setup 2. Configure OAuth settings and obtain client credentials 3. Generate a refresh token using the OAuth2 flow 4. Set environment variables as shown in the configuration section

🏗️ Architecture

Core Components

- Authentication Manager - Dual OAuth2/Username-Password support - Connection Manager - Singleton pattern with health monitoring - Tool Classes - Organized by functionality (Query, Apex, Data, Metadata) - Error Handler - Comprehensive error formatting with context - Cache Manager - TTL-based caching for performance optimization

Performance Features

- Auto-Bulk Switching - Automatically uses Bulk API for large operations - Intelligent Caching - SObject metadata cached for 1 hour - Connection Reuse - Single connection across all operations - Polling Optimization - Efficient monitoring of long-running operations

🧪 Testing

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

Install

Add to Claude Desktop or Cursor

{
    "mcpServers": {
        "salesforce mcp server": {
            "salesforce": {
                "command": "npx",
                "args": [
                    "-y",
                    "@jjar/salesforce-mcp-server"
                ],
                "env": {
                    "SF_USERNAME": "your-username@company.com",
                    "SF_PASSWORD": "your-password",
                    "SF_SECURITY_TOKEN": "",
                    "SF_LOGIN_URL": "https://login.salesforce.com"
                },
                "disabled": false,
                "alwaysAllow": [
                    "test-connection",
                    "execute-soql",
                    "describe-sobject",
                    "get-record",
                    "get-apex-logs",
                    "list-metadata-types"
                ]
            }
        }
    }
}

More like this

Similar MCP servers you might find useful

Browse category

Sequential Thinking

Sequential Thinking is an MCP server that provides a tool for dynamic and reflective problem-solving through a structured, step-by-step thinking process. It is…

88.2k
Other

Filesystem

Filesystem is a Node.js server that implements the Model Context Protocol (MCP) for filesystem operations. It enables AI assistants to read, write, and manage…

88.1k
Other