Skip to content

Langchain integration for Salesforce CRM, providing tools for SOQL queries, object schema inspection, and CRUD operations through Langchain's framework

License

Notifications You must be signed in to change notification settings

colesmcintosh/langchain-salesforce

Repository files navigation

langchain-salesforce

PyPI version License: MIT Python Versions CI

LangChain integration for Salesforce CRM. Query data with SOQL, inspect schemas, and manage records (CRUD) directly from your LangChain applications.

Installation

pip install -U langchain-salesforce

Configuration

Set these environment variables:

Variable Description
SALESFORCE_USERNAME Your Salesforce username
SALESFORCE_PASSWORD Your Salesforce password
SALESFORCE_SECURITY_TOKEN Your Salesforce security token
SALESFORCE_DOMAIN login (production) or test (sandbox). Default: login

Quick Start

from langchain_salesforce import SalesforceTool

tool = SalesforceTool()

# Query contacts
result = tool.run({
    "operation": "query",
    "query": "SELECT Id, Name, Email FROM Contact LIMIT 5"
})

Operations

Operation Description Required Parameters
query Execute SOQL queries query
describe Get object schema object_name
list_objects List all SObjects
create Create a record object_name, record_data
update Update a record object_name, record_id, record_data
delete Delete a record object_name, record_id
get_field_metadata Get field details object_name, field_name

Examples

# Describe an object
tool.run({"operation": "describe", "object_name": "Account"})

# Create a record
tool.run({
    "operation": "create",
    "object_name": "Contact",
    "record_data": {"LastName": "Doe", "Email": "doe@example.com"}
})

# Update a record
tool.run({
    "operation": "update",
    "object_name": "Contact",
    "record_id": "003XXXXXXXXXXXXXXX",
    "record_data": {"Email": "updated@example.com"}
})

# Delete a record
tool.run({"operation": "delete", "object_name": "Contact", "record_id": "003XXXXXXXXXXXXXXX"})

# Get field metadata
tool.run({"operation": "get_field_metadata", "object_name": "Contact", "field_name": "Email"})

Development

git clone https://github.com/colesmcintosh/langchain-salesforce.git
cd langchain-salesforce
uv sync --all-groups

make format  # Format code
make lint    # Run linters
make test    # Run tests

See CONTRIBUTING.md for guidelines.

License

MIT License. See LICENSE.

About

Langchain integration for Salesforce CRM, providing tools for SOQL queries, object schema inspection, and CRUD operations through Langchain's framework

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •