Skip to main content

Salesforce MCP Connector 🚀

Must read - This is not an official Salesforce repository.

Welcome to the Salesforce Model Context Protocol server! This MCP allows you to interact with your Salesforce data and metadata using natural language.

Whether you're a business user, developer, or administrator, you can now chat with your Salesforce org to: Get insights, Manage data, Configure the platform, create objects, fields, flows.. delete them, automate tasks and many more.

Quick Start ⚡

https://github.com/user-attachments/assets/60c8a448-c953-4399-99b3-7c3a1c976aa7

Option 1: Cloud Version (Recommended for Most Users) ☁️

  1. Visit salesforce-mcp.com
  2. Click "Connect to Salesforce" and authenticate with your org
  3. Start chatting with your Salesforce data right away, be aware that its not an official Salesforce product!

Option 2: Local Version (Recommended for Developers) 💻

  1. Follow the configuration steps below
  2. Set up your environment variables
  3. Use with your preferred MCP-compatible AI assistant

What You Can Do? ✨

Work with your data

  1. Ask Questions About Your Data 🔍

    • Get insights about your Salesforce records
    • Example: "Show me all accounts created in the last 30 days with their names and annual revenue"
    • The AI will automatically translate this into the appropriate Salesforce query
  2. Search Across Your Org 🔎

    • Find information across all your Salesforce records
    • Example: "Find all records containing 'Acme' in any field"
    • Works like a powerful search engine for your Salesforce data
  3. Understand Your Data Structure 📊

    • Explore available fields and objects
    • Example: "What fields are available on the Account object?"
    • Get a clear view of your data model
  4. Manage Your Records 📝

    • Create, update, and delete records with natural language
    • Examples:
      • "Create a new Account named 'Acme Corp' with industry 'Technology'"
      • "Update the phone number of Account 001xx000003DIloAAG to '555-0123'"
      • "Delete the Account with ID 001xx000003DIloAAG"
      • "Create a new user"...

Work with your Metadata

  1. Create objects and fields 🛠️

    • Access and manage your Salesforce Object Manager
    • Example: "Create a new custom object named "Contract with 3 fields: Name, Id and type"
    • Perfect for developers and administrators
  2. Delete objects fields 🔌

    • Interact with your custom Salesforce objects
    • Example: "Delete the field type from the Contract object"
    • Seamlessly integrate with your existing solutions
  3. Create custom tabs and apps ⚙️

    • Connect to any Salesforce API endpoint
    • Example: "Get the describe information for the Account object"
    • Unlock the full power of the Salesforce platform
  4. In Progress: Expanding Capabilities 🚀

    • We’re actively working on powerful new features to further streamline your Salesforce experience, including:
      1. Flow automation and orchestration
      2. Page Layouts
      3. Validation rules
      4. Reports and Dashboards
      5. Simplified deployments
      6. And many more...

Configuration ⚙️

For Local Installation

First install the server. To do that execute the follwing commands:

git clone https://github.com/salesforce-mcp/salesforce-mcp.git
cd salesforce-mcp
uv venv
uv pip install -e .

Then, to use this connector locally, you'll need to configure it in your claude_desktop_config.json file. Add the following to the mcpServers section:

{
    "mcpServers": {
        "salesforce": {
            "command": "uv",
            "args": [
                "--directory",
                "[REPO_CLONE_PATH]/salesforce-mcp/src",
                "run",
                "server.py"
            ],
            "env": {
                "USERNAME": "YOUR_SALESFORCE_USERNAME",
                "PASSWORD": "YOUR_SALESFORCE_PASSWORD",
                "SECURITY_TOKEN": "YOUR_SALESFORCE_SECURITY_TOKEN"
            }
        }
    }
}

Make sure to point to the local directory where the repo has been cloned and change that value for the REPO_CLONE_PATH

Replace the placeholder values with your Salesforce credentials:

  • YOUR_SALESFORCE_USERNAME: Your Salesforce username
  • YOUR_SALESFORCE_PASSWORD: Your Salesforce password
  • YOUR_SALESFORCE_SECURITY_TOKEN: Your Salesforce security token

Supported functions 📥

Supported Salesforce functions

Tool Name Description Required Input Fields Active
create_object Create a new object in Salesforce name, plural_name, api_name ✅
create_object_with_fields Create a new object in Salesforce with fields name, plural_name, api_name, fields ✅
create_custom_field Add one or more fields in the specified custom object name, plural_name, api_name, fields ✅
delete_object_fields Delete fields in a Salesforce custom object api_name, fields ✅
create_tab Creates a new Custom Tab in Salesforce (Custom Object, VF Page, or Web) tab_api_name, label, motif, tab_type ✅
create_custom_app Creates a new Lightning Custom Application api_name, label, tabs ✅
create_report_folder Creates a new Report Folder in Salesforce folder_api_name, folder_label ✅
create_dashboard_folder Creates a new Dashboard Folder in Salesforce folder_api_name, folder_label ✅
create_lightning_page Creates a new empty Lightning Page Salesforce label, description ✅
run_soql_query Executes a SOQL query against Salesforce query ✅
run_sosl_search Executes a SOSL search against Salesforce search ✅
get_object_fields Retrieves detailed information about the fields of a Salesforce object object_name ✅
create_record Creates a new record for a specified object object_name, data ✅
update_record Updates an existing record specified by its ID object_name, record_id, data ✅
delete_record Deletes a record specified by its ID object_name, record_id ✅
create_custom_metadata_type Creates a new Custom Metadata Type api_name, label, plural_name, fields ✅
describe_object_with_api Describes a full Salesforce object api_name ✅

Coming soon

Tool Name Description Required Input Fields (typical) Ready
create_validation_rule Creates a new Validation Rule on a specific object object_name, rule_name, error_condition_formula, error_message ⬜
create_report Creates or updates a Salesforce report report_name, folder_name, report_type, columns ⬜
create_dashboard Creates a new Dashboard in Salesforce dashboard_name, folder_name, components ⬜
create_report_type Creates a new Custom Report Type developer_name, label, description, base_object, category, deployed ⬜
describe_relationship_fields Detailed info about all relationship fields for an object ⬜
manage_debug_logs Manage debug logs for Salesforce users - enable, disable, or retrieve logs ⬜

Security Note 🔒

Your Salesforce credentials are stored securely and are only used to establish the connection to your org. We never store or share your credentials with third parties.

Contributing 👋

Thanks for being here! Whether you’re fixing a bug, adding a feature, or improving documentation — your help makes a big difference.

Here’s how to get started:

  1. Check out our Contributing Guidelines
  2. Take a look at the open Issues
  3. Fork the repo and create your branch
  4. Open a pull request when you’re ready

We appreciate your support and look forward to collaborating! 🚀

Support 💬

Need help? Visit our documentation or contact our support team at support@salesforce-mcp.com or in our Discord channel

License 📄

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

Metadata

Release files for salesforce-mcp 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for salesforce-mcp 0.1.1
File Size Uploaded Provenance Actions
salesforce_mcp-0.1.1.tar.gz 25.9 kB Without provenance Details for salesforce_mcp-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for salesforce-mcp 0.1.1
File Interpreter ABI Platform Actions
salesforce_mcp-0.1.1-py3-none-any.whl Python 3 none any Details for salesforce_mcp-0.1.1-py3-none-any.whl

Total release size: 56.5 kB

Release files / salesforce_mcp-0.1.1.tar.gz

Download URL salesforce_mcp-0.1.1.tar.gz
Size 25.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3d9f38a243b40a529bfd2a28af0802949ede3860288e19ffe156ff4db2e9a1b9
BLAKE2b-256 checksum
How to use checksums
c001b86e12cafd6f159fcf46a64aa3fd33b729529d4eee17bb877982a7f12d53
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Release files / salesforce_mcp-0.1.1-py3-none-any.whl

Download URL salesforce_mcp-0.1.1-py3-none-any.whl
Size 30.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dd7e5d5587e63856a52bf133292cb7bcf1199278bd9087595ab971d5445b5a0f
BLAKE2b-256 checksum
How to use checksums
ac11303f80cb9c1b79723c65b22b2f08337ec8ffc5422621f0831f93723acda9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Security for salesforce-mcp 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page