Salesforce Data Access Service

This implementation adheres to the Model Context Protocol (MCP) for accessing Salesforce resources, leveraging the jsforce library to manage API interactions.

Installation via Smithery

Install this Salesforce adapter for your Claude Desktop environment automatically using Smithery:

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

Core Capabilities

• Execution of structured query language requests (SOQL).
• Retrieval of object schema definitions (metadata).
• Operations for record creation, alteration, and removal (CUD).
• Robust management of secure authorization tokens.
• Facilitation of immediate, live data exchange.

Initialization Procedure

1. Duplicate the repository contents.
2. Transfer contents from .env.example to .env and populate required Salesforce access parameters.
3. Install required dependencies: npm install
4. Compile source code: npm run build
5. Initiate the service: npm start

Operational Functions

The server exposes the following remote procedures:

execute-soql

Run a SOQL query against your connected Salesforce organization:

{ "name": "execute-soql", "parameters": { "query": "SELECT Id, Name FROM Account WHERE CreatedDate = LAST_N_DAYS:30" } }

get-schema-details

Fetch structural information for a specified Salesforce data entity:

{ "name": "get-schema-details", "parameters": { "objectName": "Lead" } }

insert-record

Provision a new entry within a designated object type:

{ "name": "insert-record", "parameters": { "objectName": "Case", "payload": { "Subject": "Urgent Issue Report", "Priority": "High" } } }

modify-record

Apply changes to an existing entity instance:

{ "name": "modify-record", "parameters": { "objectName": "Opportunity", "recordId": "006XXXXXXXXXXXXXXX", "updates": { "StageName": "Proposal/Price Quote" } } }

erase-record

Permanently remove a specified record:

{ "name": "erase-record", "parameters": { "objectName": "Task", "recordId": "00TXXXXXXXXXXXXXXX" } }

Evaluation Execution

The integrated testing suite utilizes an MCP client targeting the primary code file, eliminating the need for repetitive compilation during testing cycles. Environment variables can be pre-loaded when invoking the test runner. Comprehensive documentation for evaluations is available here.

bash SF_CREDENTIALS_KEY=your-key npx mcp-eval src/evals/testing.ts src/adapter-functions.ts

Security Posture

Essential security guidelines: * Ensure the .env configuration file remains isolated and is never checked into version control. * Leverage Salesforce organizational IP range restrictions where feasible. * Establish a routine schedule for security token refreshment. * Evaluate the integration of supplementary authorization layers for the connector service.

Contributions

We welcome feature enhancements and bug fixes. Please submit pull requests detailing your proposed modifications.

Salesforce Data Access Service

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

Installation via Smithery

To install Salesforce Server for Claude Desktop automatically via Smithery:

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

Core Capabilities

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

Initialization Procedure

1. Clone the repository source code
2. Duplicate .env.example into .env and populate required Salesforce credentials
3. Install necessary packages: npm install
4. Compile: npm run build
5. Launch: npm start

Operational Functions

The server exposes several functions:

execute-soql

Execute SOQL queries against your Salesforce instance:

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

get-schema-details

Get metadata about a Salesforce object:

{ "name": "get-schema-details", "parameters": { "objectName": "Account" } }

insert-record

Create a new record:

{ "name": "insert-record", "parameters": { "objectName": "Lead", "payload": { "FirstName": "Jane", "LastName": "Smith", "Email": "jane.smith@corp.com" } } }

modify-record

Alter an existing record:

{ "name": "modify-record", "parameters": { "objectName": "Lead", "recordId": "00QXXXXXXXXXXXXXXX", "updates": { "Email": "jane.new@corp.com" } } }

erase-record

Remove a record:

{ "name": "erase-record", "parameters": { "objectName": "Lead", "recordId": "00QXXXXXXXXXXXXXXX" } }

Security Posture

Ensure the following practices are maintained: - Protect the .env secrets; prohibit repository commits. - Configure Salesforce access via IP whitelisting where appropriate. - Mandate periodic rotation of security tokens. - Investigate layering additional authentication controls for the MCP access point.

Contributions

All contributions and enhancements are welcomed. Kindly submit pull requests detailing your suggested updates.

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.