List Salesforce object fields

veryfront__list_salesforce_object_fields

Requires project.integrations.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug. Minimum length: 1.
object_namestringYesSalesforce object API name, for example Account. Minimum length: 1.
limitintegerNoOpt in to paging: fields per page, 1 to 100. Omit limit and cursor to read every field. Minimum: 1. Maximum: 100.
cursorstringNoOpaque continuation from page_info, at most 4096 characters. A cursor without limit reads 20 fields. Minimum length: 1. Maximum length: 4096.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_salesforce_object_fields",
    "arguments": {
      "object_name": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
totalintegerNoMinimum: 0.
page_infoobjectNoPagination cursor values for traversing the result set.
dataobject[]YesPrimary result records returned by the tool.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project ID or slug."
    },
    "object_name": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
      "description": "Salesforce object API name, for example Account."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Opt in to paging: fields per page, 1 to 100. Omit limit and cursor to read every field."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Opaque continuation from page_info, at most 4096 characters. A cursor without limit reads 20 fields."
    }
  },
  "required": [
    "object_name"
  ],
  "additionalProperties": false,
  "description": "Arguments for the list_salesforce_object_fields tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "minimum": 0
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "reference_to": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of reference to associated with this tool result."
          },
          "relationship_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "nillable": {
            "type": "boolean"
          },
          "createable": {
            "type": "boolean"
          },
          "updateable": {
            "type": "boolean"
          },
          "filterable": {
            "type": "boolean"
          },
          "sortable": {
            "type": "boolean"
          },
          "id_lookup": {
            "type": "boolean"
          },
          "external_id": {
            "type": "boolean"
          },
          "calculated": {
            "type": "boolean"
          },
          "name_field": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "label",
          "type",
          "reference_to",
          "relationship_name",
          "nillable",
          "createable",
          "updateable",
          "filterable",
          "sortable",
          "id_lookup",
          "external_id",
          "calculated",
          "name_field"
        ],
        "additionalProperties": false
      },
      "description": "Primary result records returned by the tool."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_salesforce_object_fields tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}