`sf_search`

Pack: salesforce · Endpoint: https://gateway.pipeworx.io/salesforce/mcp

Search across Salesforce objects by keyword. Returns matching records from multiple object types like Accounts, Contacts, Leads. Use for broad keyword searches.

Parameters

Name	Type	Required	Description
`search`	string	yes	SOSL search (e.g., “FIND {Acme} IN ALL FIELDS RETURNING Account(Id, Name)“)

Example call

Arguments

{
  "search": "FIND {Acme Corp} IN ALL FIELDS RETURNING Account(Id, Name), Contact(Id, FirstName, LastName)"
}

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_search","arguments":{"search":"FIND {Acme Corp} IN ALL FIELDS RETURNING Account(Id, Name), Contact(Id, FirstName, LastName)"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('sf_search', {
  "search": "FIND {Acme Corp} IN ALL FIELDS RETURNING Account(Id, Name), Contact(Id, FirstName, LastName)"
});

More examples

{
  "search": "FIND {[email protected]} IN EMAIL FIELDS RETURNING Contact(Id, Email)"
}

Response shape

Field	Type	Description
`searchRecords`	array	Array of search result records
`error`	string	Error code if search failed
`message`	string	Error message if search failed

Full JSON Schema

{
  "type": "object",
  "properties": {
    "searchRecords": {
      "type": "array",
      "description": "Array of search result records",
      "items": {
        "type": "object",
        "properties": {
          "Id": {
            "type": "string",
            "description": "Record ID"
          },
          "attributes": {
            "type": "object",
            "description": "Record metadata"
          }
        }
      }
    },
    "error": {
      "type": "string",
      "description": "Error code if search failed"
    },
    "message": {
      "type": "string",
      "description": "Error message if search 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.

sf_search