Salesforce CRM Data Connector for MCP

This component serves as a Model Context Protocol endpoint engineered for seamless interfacing with Salesforce services via its native REST API, leveraging the jsforce library.

Installation via Smithery

For automated deployment of the Salesforce Connector within the Claude Desktop environment using Smithery, execute the following command:

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

Core Capabilities

• Execute custom SOQL data retrieval commands
• Fetch detailed object structural information (metadata)
• Perform full CRUD operations (Create, Retrieve, Update, Delete) on organizational records
• Manages credential security and session lifecycles
• Offers immediate, up-to-the-second data synchronization

Deployment Steps

1. Clone the source code repository.
2. Duplicate the template file .env.example to .env and populate it with valid Salesforce access credentials.
3. Install required dependencies: npm install
4. Compile the project: npm run build
5. Initiate the service: npm start

Operational Usage Examples

The service exposes the following remote procedure calls:

queryOperation

Run a structured query language request against your Salesforce environment:

{
  "name": "query",
  "parameters": {
    "query": "SELECT Id, Name FROM Account WHERE Industry = 'Technology'"
  }
}

getSchemaMetadata

Obtain the structural blueprint for a specified Salesforce entity:

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

insertRecord

Provision a new data entity within Salesforce:

{
  "name": "create",
  "parameters": {
    "objectName": "Case",
    "data": {
      "Subject": "Urgent System Issue",
      "Status": "New",
      "Priority": "High"
    }
  }
}

modifyRecord

Apply modifications to an existing data entry:

{
  "name": "update",
  "parameters": {
    "objectName": "Opportunity",
    "data": {
      "Id": "006XXXXXXXXXXXXXXX",
      "StageName": "Negotiation/Review"
    }
  }
}

removeRecord

Permanently erase a specified record instance:

{
  "name": "delete",
  "parameters": {
    "objectName": "Task",
    "id": "001XXXXXXXXXXXXXXX"
  }
}

Security Posture

Adherence to these security guidelines is mandatory:

• Ensure the configuration file (.env) is strictly protected and never submitted to version control.
• Implement Salesforce network access restrictions (IP whitelisting) where feasible.
• Establish a routine for refreshing the security token.
• Evaluate and integrate supplemental authorization layers for the MCP server interface.

Collaboration

We encourage community involvement! Feature enhancements and fixes should be submitted via Pull Requests.

Salesforce CRM Data Connector for MCP

A Model Context Protocol server implementation for interacting with Salesforce through its REST API using jsforce.

Installing via Smithery

To install Salesforce Server for Claude Desktop automatically via Smithery:

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

Core Capabilities

• Execute SOQL data retrieval commands
• Fetch detailed object structural information (metadata)
• Perform full CRUD operations on organizational records
• Manages credential security and session lifecycles
• Offers immediate, up-to-the-second data synchronization

Deployment Steps

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

Operational Usage Examples

The service exposes the following remote procedure calls:

queryOperation

Run a structured query language request against your Salesforce environment:

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

getSchemaMetadata

Obtain the structural blueprint for a specified Salesforce entity:

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

insertRecord

Provision a new data entity within Salesforce:

{
  "name": "create",
  "parameters": {
    "objectName": "Contact",
    "data": {
      "FirstName": "Jane",
      "LastName": "Smith",
      "Email": "jane.smith@corp.com"
    }
  }
}

modifyRecord

Apply modifications to an existing data entry:

{
  "name": "update",
  "parameters": {
    "objectName": "Contact",
    "data": {
      "Id": "003XXXXXXXXXXXXXXX",
      "Email": "updated.jane@corp.com"
    }
  }
}

removeRecord

Permanently erase a specified record instance:

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

Security Posture

Adherence to these security guidelines is mandatory:

• Ensure the configuration file (.env) is strictly protected and never submitted to version control
• Implement Salesforce network access restrictions (IP whitelisting) where feasible
• Establish a routine for refreshing the security token
• Evaluate and integrate supplemental authorization layers for the MCP server interface

Collaboration

Contributions are welcome! Please submit PRs with improvements.

License

MIT License

MIT License

Copyright (c) 2024 Kablewy,LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.