sf_query
Pack: salesforce · Endpoint: https://gateway.pipeworx.io/salesforce/mcp
Query Salesforce records using SOQL. Returns matching records with all requested fields. Use sf_describe first to learn available fields for your object.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
query | string | yes | SOQL query (e.g., “SELECT Id, Name FROM Account LIMIT 10”) |
Example call
Arguments
{
"query": "SELECT Id, Name, Industry FROM Account LIMIT 10"
}
curl
curl -X POST https://gateway.pipeworx.io/salesforce/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"sf_query","arguments":{"query":"SELECT Id, Name, Industry FROM Account LIMIT 10"}}}'
TypeScript (@pipeworx/sdk)
import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();
const result = await pipeworx.call('sf_query', {
"query": "SELECT Id, Name, Industry FROM Account LIMIT 10"
});
More examples
{
"query": "SELECT Id, FirstName, LastName, Email FROM Contact WHERE Email LIKE '%@acme.com%'"
}
Response shape
| Field | Type | Description |
|---|---|---|
totalSize | number | Total number of records matching query |
done | boolean | Whether all records have been returned |
records | array | Array of matching records |
error | string | Error code if connection failed |
message | string | Error message if connection failed |
Full JSON Schema
{
"type": "object",
"properties": {
"totalSize": {
"type": "number",
"description": "Total number of records matching query"
},
"done": {
"type": "boolean",
"description": "Whether all records have been returned"
},
"records": {
"type": "array",
"description": "Array of matching records",
"items": {
"type": "object"
}
},
"error": {
"type": "string",
"description": "Error code if connection failed"
},
"message": {
"type": "string",
"description": "Error message if connection failed"
}
}
}
Connect
Add this to your MCP client config, or use one-click install buttons:
{
"mcpServers": {
"salesforce": {
"url": "https://gateway.pipeworx.io/salesforce/mcp"
}
}
}
See Getting Started for client-specific install steps.