salesforce_skill

Overview

This skill provides programmatic access to a Salesforce CRM org using Python and the simple-salesforce library. It helps you view accounts, contacts, leads, opportunities, custom objects, and run SOQL/SOSL searches. Use it to run read queries quickly, describe object schemas, and perform write operations only after explicit permission.

How this skill works

The skill uses environment-stored Salesforce credentials (username, password, security token) and the simple-salesforce Python client to connect to your org. It exposes quick, copy-paste python3 -c command patterns to test connections, list objects, describe fields, run SOQL/SOSL queries, and handle pagination. Write operations (create/update/delete) are supported but gated by explicit user consent and best-practice safeguards.

When to use it

• You need to list or describe Salesforce objects and their fields.
• You want to run SOQL queries or SOSL searches from a terminal or script.
• You need quick examples to fetch accounts, contacts, leads, or opportunities.
• You want to test or validate a Salesforce connection from a CI or local environment.
• You plan to perform creates/updates/deletes and will grant explicit permission.

Best practices

• Store SF_USERNAME, SF_PASSWORD, and SF_SECURITY_TOKEN in environment variables; never paste credentials in chat.
• Install python3 and the simple-salesforce package before running commands.
• Use minimal-field SOQL queries to limit returned data and follow privacy rules.
• Run read-only queries by default; request explicit confirmation before any write operations.
• Format results as concise tables or summaries rather than raw JSON dumps.

Example use cases

• Check connection and confirm sf_instance for troubleshooting.
• List the first 20 queryable objects to discover custom object names.
• Describe Account or any object to see available fields and types before building a query.
• Run a SOQL query to list open opportunities closing this month with amounts and close dates.
• Search for contacts or accounts by name using SOSL and return Ids and display names.