Kablewy Salesforce MCP Server

🚀 Salesforce MCP 服务器

这是一个通过 jsforce 利用 Salesforce 的 REST API 实现的 Model Context Protocol 服务器，可助力您执行各类 Salesforce 操作，如查询、数据管理等，为您提供便捷且安全的数据交互体验。

🚀 快速开始

若要使用此服务器，您需完成以下设置步骤：

1. 克隆仓库。
2. 复制 .env.example 到 .env，并填写您的 Salesforce 凭据。
3. 安装依赖项：npm install。
4. 构建项目：npm run build。
5. 启动服务器：npm start。

✨ 主要特性

• 执行 SOQL 查询，方便获取所需数据。
• 获取对象元数据，深入了解 Salesforce 对象信息。
• 支持创建、更新和删除记录，实现数据的灵活管理。
• 具备安全的身份验证处理，保障数据交互安全。
• 可进行实时数据访问，及时获取最新数据。

💻 使用示例

基础用法

服务器公开了几个实用功能，以下是具体的使用示例：

query

对您的 Salesforce 实例执行 SOQL 查询：

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

describe-object

获取有关 Salesforce 对象的元数据：

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

delete

删除记录：

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

🔧 安全

⚠️ 重要提示

• 请保持 .env 文件安全，切勿提交它，防止凭据泄露。
• 尽可能使用 Salesforce 中的 IP 限制，增强访问安全性。
• 定期轮换您的安全令牌，降低安全风险。
• 考虑为 MCP 服务器实现额外的身份验证，进一步保障系统安全。

🤝 贡献

欢迎大家贡献代码！如果您有改进建议，请提交带有改进内容的 PR。

📄 许可证

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.