Salesforce MCP Server

🚀 Salesforce MCP Server

A Model Context Protocol server implemented via Salesforce's REST API using jsforce.

🚀 Quick Start

Installation via Smithery

To automatically install it as a Claude desktop version through Smithery:

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

✨ Features

• Execute SOQL queries.
• Retrieve object metadata.
• Create, update, and delete records.
• Secure authentication handling.
• Real-time data access.

📦 Installation

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

💻 Usage Examples

Basic Usage

The server exposes the following functions:

query

Execute a SOQL query on your Salesforce instance:

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

describe-object

Retrieve metadata about a Salesforce object:

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

create

Create a new record:

{
  "name": "create", 
  "parameters": {
    "objectName": "Contact",
    "data": {
      "FirstName": "John",
      "LastName": "Doe",
      "Email": "john.doe@example.com"
    }
  }
}

update

Update an existing record:

{
  "name": "update",
  "parameters": {
    "objectName": "Contact",
    "data": {
      "FirstName": "John",
      "LastName": "Doe",
      "Email": "john.doe@example.com"
    }
  }
}

delete

Delete a record:

{
  "name": "delete",
  "parameters": {
    "objectName": "Contact",
    "data": {
      "Id": "some_id"
    }
  }
}

📚 Documentation

Security Precautions

• Ensure all sensitive information (e.g., API keys) is stored securely.
• Use HTTPS for communication.
• Regularly update dependency libraries to prevent known vulnerabilities.
• Configure appropriate authentication and authorization mechanisms.

Contribution Guidelines

Contributions are welcome! Please improve the project by submitting pull requests.

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