run_sosl_search
Execute SOSL searches to find Salesforce data across multiple objects and fields using a single query, enabling comprehensive data discovery within the Salesforce platform.
Instructions
Executes a SOSL search against Salesforce
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | Yes | The SOSL search to execute (e.g., 'FIND {John Smith} IN ALL FIELDS') |
Implementation Reference
- src/salesforce/server.py:327-338 (handler)Handler function block that executes the SOSL search using simple-salesforce's search method and returns formatted JSON results.
elif name == "run_sosl_search": search = arguments.get("search") if not search: raise ValueError("Missing 'search' argument") results = sf_client.sf.search(search) return [ types.TextContent( type="text", text=f"SOSL Search Results (JSON):\n{json.dumps(results, indent=2)}", ) ] - src/salesforce/server.py:119-132 (registration)Tool registration in list_tools() including name, description, and input schema requiring a 'search' string parameter.
types.Tool( name="run_sosl_search", description="Executes a SOSL search against Salesforce", inputSchema={ "type": "object", "properties": { "search": { "type": "string", "description": "The SOSL search to execute (e.g., 'FIND {John Smith} IN ALL FIELDS')", }, }, "required": ["search"], }, ),