Skip to content
View salesforce-mcp's full-sized avatar

Block or report salesforce-mcp

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Please don't include any personal information such as legal names or email addresses. Maximum 100 characters, markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
salesforce-mcp/README.md

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 ⚡

sfdc-mcp.mp4

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

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": "uvx",
            "args": [
                "--from",
                "salesforce-mcp",
                "salesforce"
            ],
            "env": {
                "USERNAME": "YOUR_SALESFORCE_USERNAME",
                "PASSWORD": "YOUR_SALESFORCE_PASSWORD",
                "SECURITY_TOKEN": "YOUR_SALESFORCE_SECURITY_TOKEN"
            }
        }
    }
}

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
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

Coming soon

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_custom_metadata_type Creates a new Custom Metadata Type api_name, label, plural_name, fields
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
create_full_app Creates a full Salesforce application (custom app) api_name, label, tabs
describe_object_with_api Describes a full Salesforce object api_name
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 [email protected] or in our Discord channel

License 📄

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

Popular repositories Loading

  1. salesforce-mcp salesforce-mcp Public

    Salesforce MCP

    Python 49 3