Salesforce MCP Server

An MCP (Model Context Protocol) server implementation that integrates Claude with Salesforce, enabling natural language interactions with your Salesforce data and metadata. This server allows Claude to query, modify, and manage your Salesforce objects and records using everyday language.

Features

• Object and Field Management: Create and modify custom objects and fields using natural language
• Smart Object Search: Find Salesforce objects using partial name matches
• Detailed Schema Information: Get comprehensive field and relationship details for any object
• Flexible Data Queries: Query records with relationship support and complex filters
• Data Manipulation: Insert, update, delete, and upsert records with ease
• Cross-Object Search: Search across multiple objects using SOSL
• Intuitive Error Handling: Clear feedback with Salesforce-specific error details

Installation

npm install -g @surajadsul02/mcp-server-salesforce

Tools

salesforce_search_objects

Search for standard and custom objects:

• Search by partial name matches
• Finds both standard and custom objects
• Example: "Find objects related to Account" will find Account, AccountHistory, etc.

salesforce_describe_object

Get detailed object schema information:

• Field definitions and properties
• Relationship details
• Picklist values
• Example: "Show me all fields in the Account object"

salesforce_query_records

Query records with relationship support:

• Parent-to-child relationships
• Child-to-parent relationships
• Complex WHERE conditions
• Example: "Get all Accounts with their related Contacts"

salesforce_dml_records

Perform data operations:

• Insert new records
• Update existing records
• Delete records
• Upsert using external IDs
• Example: "Update status of multiple accounts"

salesforce_manage_object

Create and modify custom objects:

• Create new custom objects
• Update object properties
• Configure sharing settings
• Example: "Create a Customer Feedback object"

salesforce_manage_field

Manage object fields:

• Add new custom fields
• Modify field properties
• Create relationships
• Example: "Add a Rating picklist field to Account"

salesforce_search_all

Search across multiple objects:

• SOSL-based search
• Multiple object support
• Field snippets
• Example: "Search for 'cloud' across Accounts and Opportunities"

Setup

Salesforce Authentication

You can authenticate with Salesforce using one of two methods:

1. Username/Password Authentication

1. Set up your Salesforce credentials
2. Get your security token (Reset from Salesforce Settings)
3. Configure the following environment variables:
   • SALESFORCE_USERNAME: Your Salesforce username
   • SALESFORCE_PASSWORD: Your Salesforce password
   • SALESFORCE_TOKEN: Your Salesforce security token
   • SALESFORCE_INSTANCE_URL: Your org URL (Optional. Default: https://login.salesforce.com)

2. OAuth2 Authentication with Consumer Key/Secret

1. Set up a Connected App in Salesforce
2. Get the Consumer Key and Consumer Secret
3. Configure the following environment variables:
   • SALESFORCE_CONSUMER_KEY: Your Connected App's consumer key
   • SALESFORCE_CONSUMER_SECRET: Your Connected App's consumer secret
   • SALESFORCE_USERNAME: Your Salesforce username
   • SALESFORCE_PASSWORD: Your Salesforce password
   • SALESFORCE_INSTANCE_URL: Your org URL (Optional. Default: https://login.salesforce.com)

Note: When using OAuth2 authentication, username and password are still required for the JWT bearer flow.

Usage with Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "salesforce": {
      "command": "npx",
      "args": ["-y", "@tsmztech/mcp-server-salesforce"],
      "env": {
        // For Username/Password Authentication
        "SALESFORCE_USERNAME": "your_username",
        "SALESFORCE_PASSWORD": "your_password",
        "SALESFORCE_TOKEN": "your_security_token",
        "SALESFORCE_INSTANCE_URL": "org_url",        // Optional. Default value: https://login.salesforce.com

        // For OAuth2 Authentication (alternative)
        "SALESFORCE_CONSUMER_KEY": "your_consumer_key",
        "SALESFORCE_CONSUMER_SECRET": "your_consumer_secret"
        // Username and password still required for OAuth2
      }
    }
  }
}

Example Usage

Searching Objects

"Find all objects related to Accounts"
"Show me objects that handle customer service"
"What objects are available for order management?"

Getting Schema Information

"What fields are available in the Account object?"
"Show me the picklist values for Case Status"
"Describe the relationship fields in Opportunity"

Querying Records

"Get all Accounts created this month"
"Show me high-priority Cases with their related Contacts"
"Find all Opportunities over $100k"

Managing Custom Objects

"Create a Customer Feedback object"
"Add a Rating field to the Feedback object"
"Update sharing settings for the Service Request object"

Searching Across Objects

"Search for 'cloud' in Accounts and Opportunities"
"Find mentions of 'network issue' in Cases and Knowledge Articles"
"Search for customer name across all relevant objects"

Development

Building from source

# Clone the repository
git clone https://github.com/tsmztech/mcp-server-salesforce.git

# Navigate to directory
cd mcp-server-salesforce

# Install dependencies
npm install

# Build the project
npm run build

Contributing

Contributions are welcome! Feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Issues and Support

If you encounter any issues or need support, please file an issue on the GitHub repository.