返回 MCP 目录
public公开dns本地运行

salesforce-mcp-server

Salesforce MCP服务器是一个通过REST API与Salesforce交互的协议服务器实现,提供数据查询、元数据获取和记录操作功能。

article

README

🚀 Salesforce MCP 服务器

Salesforce MCP 服务器是一个借助 jsforce 通过 Salesforce 的 REST API 实现的 Model Context Protocol 服务器,可高效执行各类 Salesforce 操作。

smithery badge

🚀 快速开始

使用 Smithery 安装

你可以通过 Smithery 自动将其安装为 Claude 桌面版,具体命令如下:

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

✨ 主要特性

  • 🔍 执行 SOQL 查询
  • 📋 获取对象元数据
  • ➕ 创建、更新和删除记录
  • 🔒 安全的身份验证处理
  • 🔄 实时数据访问

📦 安装指南

  1. 克隆仓库:将项目仓库克隆到本地。
  2. 配置环境变量:复制 .env.example.env,并填入你的 Salesforce 凭据。
  3. 安装依赖:在项目根目录下执行 npm install 安装所需依赖。
  4. 构建项目:运行 npm run build 进行项目构建。
  5. 启动服务:执行 npm start 启动服务器。

💻 使用示例

该服务器暴露了以下功能,以下是具体使用示例:

基础用法

query:执行 SOQL 查询

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

describe-object:获取对象元数据

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

create:创建新记录

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

update:更新现有记录

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

delete:删除记录

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

📚 详细文档

安全注意事项

⚠️ 重要提示

  • 务必确保所有敏感信息(如 API 密钥)安全存储。
  • 使用 HTTPS 进行通信,保障数据传输安全。
  • 定期更新依赖库,以防范已知漏洞。
  • 配置适当的身份验证和授权机制,防止非法访问。

贡献指南

贡献是欢迎的!请通过提交拉取请求改进项目。

📄 许可证

本项目采用 MIT License 进行授权。

MIT License

版权 (c) 2024 Kablewy, LLC

准许任何人获取本软件及关联文档文件副本("软件"),并免费使用、复制、修改、合并、发布、分发、转许可和/或出售该软件,并允许获得软件副本的人这样做,但需遵守以下条件:

本版权声明和本许可声明必须在所有软件副本或其重要部分中包含。

软件按“原样”提供,不做任何形式的担保,包括但不限于适销性、特定用途的适用性和无侵权的明示或暗示保证。作者或版权所有者不对任何因使用、操作、改编、分发或以其他方式使用本软件所引起的损害承担责任。
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端