Salesforce MCP server

The Salesforce MCP Server is a Model Context Protocol implementation that enables interaction with Salesforce through its REST API using jsforce. It allows you to query data, manage records, and access object metadata from your Salesforce instance directly.

Installation

Quick Installation via Smithery

The easiest way to install 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
3. Fill in your Salesforce credentials in the .env file
4. Install dependencies:

   npm install
   

5. Build the server:

   npm run build
   

6. Start the server:

   npm start
   

Usage

The server provides several functions to interact with your Salesforce instance:

Executing SOQL Queries

Query your Salesforce data using SOQL:

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

Retrieving Object Metadata

Get detailed information about a Salesforce object and its fields:

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

Creating Records

Add new records to your Salesforce instance:

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

Updating Records

Modify existing records:

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

Deleting Records

Remove records from Salesforce:

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

Security Recommendations

When using the Salesforce MCP Server, follow these security best practices:

• 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 add this MCP server to 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 > MCP and click "Add new global MCP server".

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

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

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 explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.