Salesforce MCP server

Integrates with Salesforce's REST API to enable querying, metadata retrieval, and CRUD operations on Salesforce data for tasks like customer analysis and CRM automation.
Back to servers
Setup instructions
Provider
kablewy
Release date
Dec 07, 2024
Language
TypeScript
Stats
38 stars

The Salesforce MCP Server is a Model Context Protocol implementation that allows you to interact with Salesforce through its REST API using jsforce. It provides a streamlined way to execute SOQL queries, manage records, and access Salesforce metadata.

Installation

Quick Installation via Smithery

The easiest way to install the Salesforce Server for Claude Desktop is through Smithery:

npx -y @smithery/cli install salesforce-mcp-server --client claude

Manual Installation

If you prefer to install manually:

  1. Clone the repository
  2. Copy .env.example to .env and fill in your Salesforce credentials
  3. Install dependencies:
    npm install
    
  4. Build the server:
    npm run build
    
  5. Start the server:
    npm start
    

Usage

The Salesforce MCP Server exposes several functions for interacting with your Salesforce instance:

Executing SOQL Queries

To query your Salesforce data:

{
  "name": "query",
  "parameters": {
    "query": "SELECT Id, Name FROM Account LIMIT 5"
  }
}

Retrieving Object Metadata

Get detailed information about a Salesforce object:

{
  "name": "describe-object",
  "parameters": {
    "objectName": "Account"
  }
}

Creating Records

Create a new record in Salesforce:

{
  "name": "create",
  "parameters": {
    "objectName": "Contact",
    "data": {
      "FirstName": "John",
      "LastName": "Doe",
      "Email": "[email protected]"
    }
  }
}

Updating Records

Update an existing record:

{
  "name": "update",
  "parameters": {
    "objectName": "Contact",
    "data": {
      "Id": "003XXXXXXXXXXXXXXX",
      "Email": "[email protected]"
    }
  }
}

Deleting Records

Delete a record from Salesforce:

{
  "name": "delete",
  "parameters": {
    "objectName": "Contact",
    "id": "003XXXXXXXXXXXXXXX"
  }
}

Security Recommendations

When using the Salesforce MCP Server, ensure you:

  • Keep your .env file secure and never commit it to version control
  • Use IP restrictions in Salesforce when possible
  • Regularly rotate your security token
  • Consider implementing additional authentication for the MCP server

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "salesforce-mcp-server" '{"command":"npx","args":["-y","salesforce-mcp-server"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "salesforce-mcp-server": {
            "command": "npx",
            "args": [
                "-y",
                "salesforce-mcp-server"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "salesforce-mcp-server": {
            "command": "npx",
            "args": [
                "-y",
                "salesforce-mcp-server"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect

Want to 10x your AI skills?

Get a free account and learn to code + market your apps using AI (with or without vibes!).

Nah, maybe later