`sf_describe`

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

Get schema details for a Salesforce object (e.g., ‘Account’). Returns field names, types, relationships, and metadata. Use before querying to understand available fields.

Parameters

Name	Type	Required	Description
`object`	string	yes	SObject type (e.g., “Account”)

Example call

Arguments

{
  "object": "Account"
}

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_describe","arguments":{"object":"Account"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('sf_describe', {
  "object": "Account"
});

More examples

{
  "object": "Opportunity"
}

Response shape

Field	Type	Description
`name`	string	SObject type name
`label`	string	SObject display label
`fields`	array	Array of field definitions
`error`	string	Error code if describe failed
`message`	string	Error message if describe failed

Full JSON Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "SObject type name"
    },
    "label": {
      "type": "string",
      "description": "SObject display label"
    },
    "fields": {
      "type": "array",
      "description": "Array of field definitions",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Field name"
          },
          "type": {
            "type": "string",
            "description": "Field data type"
          },
          "label": {
            "type": "string",
            "description": "Field display label"
          },
          "required": {
            "type": "boolean",
            "description": "Whether field is required"
          },
          "createable": {
            "type": "boolean",
            "description": "Whether field can be created"
          },
          "updateable": {
            "type": "boolean",
            "description": "Whether field can be updated"
          },
          "referenceTo": {
            "type": "array",
            "description": "Referenced object types for relationships",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "error": {
      "type": "string",
      "description": "Error code if describe failed"
    },
    "message": {
      "type": "string",
      "description": "Error message if describe 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_describe