# Salesforce CRM

import ToolInfo from "@/app/_components/tool-info";
import Badges from "@/app/_components/badges";
import TabbedCodeBlock from "@/app/_components/tabbed-code-block";
import TableOfContents from "@/app/_components/table-of-contents";
import { Callout } from "nextra/components";

<Callout type="info">
  At this time, Arcade does not offer a default Salesforce Auth Provider. To use
  Salesforce auth and MCP Sever, you must create a custom Auth Provider with your
  own Salesforce OAuth 2.0 credentials as documented in [Salesforce Auth
  Provider](/references/auth-providers/salesforce).
</Callout>

<ToolInfo
  description="Enable agents to interact with accounts, leads, contacts, etc in the Salesforce CRM."
  author="Arcade"
  authType="OAuth 2.0"
  versions={["0.1.0"]}
/>

<Badges repo="arcadeai/arcade_salesforce" />

The Arcade Salesforce CRM MCP Server provides a pre-built set of tools for interacting with Accounts, Leads, Contacts, etc in the Salesforce CRM. These tools make it easy to build agents and AI apps that can:

- Search for Accounts and Contacts by keywords or retrieve them by ID
- Read information about Accounts, such as company metadata, opportunities, deals, etc.
- Read information about Contacts, such as name, email addresses, phone numbers, email messages, call logs, notes, meetings, tasks, etc.
- Create contacts

## Install and Run the Arcade Engine

At this time, you need to [self-host](/references/auth-providers/salesforce) the Arcade Engine to use the Salesforce MCP Sever. Follow the step-by-step instructions in the [Salesforce Auth Provider](/references/auth-providers/salesforce) page.

## Install

```bash
pip install arcade_salesforce
```

## Available Tools

<TableOfContents
  headers={["Tool Name", "Description"]}
  data={[
    [
      "Salesforce.GetAccountDataByKeywords",
      "Searches for accounts in Salesforce and returns them with related info: contacts, leads, notes, calls, opportunities, tasks, emails, and events.",
    ],
    [
      "Salesforce.GetAccountDataByID",
      "Gets the account with related info (contacts, leads, notes, calls, etc).",
    ],
    [
      "Salesforce.CreateContact",
      "Creates a contact in Salesforce associated with an account.",
    ],
  ]}
/>

<Callout>
  If you need to perform an action that's not listed here, you can [get in touch
  with us](mailto:contact@arcade.dev) to request a new tool, or [create your own
  tools](/guides/create-tools/tool-basics/build-mcp-server).
</Callout>

<Callout type="info">
  In order to use the Salesforce MCP Sever, you must [self-host the Arcade
  Engine](/guides/deployment-hosting/configure-engine) and [configure the Salesforce
  auth provider](/references/auth-providers/salesforce). The Arcade Engine is
  available at `http://localhost:9099` by default. In the code examples below,
  if necessary, adjust the `base_url` (in Python) or `baseURL` (in JavaScript)
  parameter in the `Arcade` client constructor to match your environment.
</Callout>

## Salesforce.GetAccountDataByKeywords

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_keywords_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_keywords_example_call_tool.js",
        ],
      },
    },
    {
      label: "Execute the Tool with OpenAI",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_keywords_example_llm_oai.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_keywords_example_llm_oai.js",
        ],
      },
    },
  ]}
/>

Searches for accounts in Salesforce and returns them with related info: contacts, leads, notes, calls, opportunities, tasks, emails, and events (up to 10 items of each type).

**Parameters**

- **query** _(string, required)_ The query to search for accounts. MUST be longer than one character. It will match the keywords against all account fields, such as name, website, phone, address, etc. E.g. 'Acme'.
- **limit** _(int, optional, Defaults to `10`)_ The maximum number of accounts to return. Defaults to 10. Maximum allowed is 10.
- **page** _(string, optional)_ The page number to return. Defaults to 1 (first page of results)."

## Salesforce.GetAccountDataByID

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_id_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_id_example_call_tool.js",
        ],
      },
    },
    {
      label: "Execute the Tool with OpenAI",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_id_example_llm_oai.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/salesforce/get_account_data_by_id_example_llm_oai.js",
        ],
      },
    },
  ]}
/>

Gets the account with related info: contacts, leads, notes, calls, opportunities, tasks, emails, and events (up to 10 items of each type).

**Parameters**

- **account_id** _(string, required)_ The ID of the account to get data for.

## Salesforce.CreateContact

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/salesforce/create_contact_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/salesforce/create_contact_example_call_tool.js",
        ],
      },
    },
    {
      label: "Execute the Tool with OpenAI",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/salesforce/create_contact_example_llm_oai.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/salesforce/create_contact_example_llm_oai.js",
        ],
      },
    },
  ]}
/>

Creates a contact in Salesforce associated with an account.

**Parameters**

- **account_id** _(string, required)_ The ID of the account to create the contact for.
- **first_name** _(string, required)_ The first name of the contact.
- **last_name** _(string, required)_ The last name of the contact.
- **email** _(string, required)_ The email address of the contact.
- **phone** _(string, optional)_ The phone number of the contact.
- **mobile_phone** _(string, optional)_ The mobile phone number of the contact.
- **title** _(string, optional)_ The title of the contact. E.g. 'CEO', 'Sales Director', 'CTO', etc.
- **department** _(string, optional)_ The department of the contact. E.g. 'Marketing', 'Sales', 'IT', etc.".
- **description** _(string, optional)_ A description of the contact.

## Self-hosting the Arcade Engine with Salesforce Auth

At this time, Arcade Cloud does not support Salesforce auth.

In order to use the Salesforce MCP Sever (or develop custom tools for Salesforce), you have to [self-host the Arcade Engine](/guides/deployment-hosting/configure-engine) and [configure the Salesforce auth provider](/references/auth-providers/salesforce) in your engine configuration.