Salesforce Data Access Mediator (MCP Endpoint)

This implementation leverages jsforce to bridge Model Context Protocol requests with the native Salesforce REST interface.

Installation via Smithery

For automated deployment to your Claude Desktop environment using Smithery:

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

Core Capabilities

• Execution of arbitrary SOQL data retrieval statements
• Schema introspection for data modeling purposes
• Full lifecycle management for data entities (Insert, Modify, Erase)
• Integrated, secure handling of authorization tokens
• Low-latency access to current organizational data

Preliminary Configuration

1. Acquire the source code repository.
2. Duplicate the .env.example file, renaming it to .env, and populate it with requisite Salesforce access keys.
3. Establish node dependencies: npm install
4. Compile assets: npm run build
5. Initiate the service: npm start

Available Procedures

query

Submit a SOQL statement to the target Salesforce organization:

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

describe-object

Fetch structural information pertaining to a specified Salesforce entity type:

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

create

Provision a new record instance within a designated object:

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

update

Modify the fields of an existing entity identified by its unique key:

{ "name": "update", "parameters": { "objectName": "Contact", "data": { "Id": "003XXXXXXXXXXXXXXX", "Email": "new.email@example.com" } } }

delete

Permanently eliminate a specified data record:

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

Security Posture

Mandatory safeguards include: - Strictly protect the .env configuration file; avoid version control commits. - Implement network access restrictions (IP whitelisting) within Salesforce whenever feasible. - Adhere to a schedule for refreshing authentication tokens. - Consider augmenting the MCP server's ingress security layers.

Collaboration

Contributions aimed at refinement are actively encouraged via pull requests.

Salesforce Data Access Mediator (MCP Endpoint)

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

Preliminary Configuration

1. Clone the 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

Available Procedures

The service exposes several utility routines:

query

Execute SOQL queries against your Salesforce instance:

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

describe-object

Get 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": { "Id": "003XXXXXXXXXXXXXXX", "Email": "new.email@example.com" } } }

delete

Delete a record:

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

Security Posture

Ensure adherence to these security guidelines: - Maintain privacy of the .env artifact; never commit secrets. - Utilize Salesforce's native network perimeter controls (IP restrictions). - Periodically refresh access security credentials. - Evaluate implementation of supplementary authorization layers for the service 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.