run_soql_query
Execute SOQL queries to retrieve Salesforce data for analysis, reporting, or integration purposes.
Instructions
Executes a SOQL query against Salesforce
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The SOQL query to execute |
Implementation Reference
- src/salesforce/server.py:306-317 (handler)Handler logic for the run_soql_query tool: extracts query argument, executes sf_client.sf.query_all, formats results as JSON text content.
if name == "run_soql_query": query = arguments.get("query") if not query: raise ValueError("Missing 'query' argument") results = sf_client.sf.query_all(query) return [ types.TextContent( type="text", text=f"SOQL Query Results (JSON):\n{json.dumps(results, indent=2)}", ) ] - src/salesforce/server.py:96-109 (registration)Registration of run_soql_query tool in list_tools(), including name, description, and inputSchema.
types.Tool( name="run_soql_query", description="Executes a SOQL query against Salesforce", inputSchema={ "type": "object", "properties": { "query": { "type": "string", "description": "The SOQL query to execute", }, }, "required": ["query"], }, ), - src/salesforce/server.py:99-108 (schema)JSON Schema for run_soql_query input: requires 'query' string.
inputSchema={ "type": "object", "properties": { "query": { "type": "string", "description": "The SOQL query to execute", }, }, "required": ["query"], },