# Google Contacts

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 ToolFooter from "@/app/_components/tool-footer";
import ScopePicker from "@/app/_components/scope-picker";
import { Callout } from "nextra/components";

<ToolInfo
  description="Enable agents to interact with Google Contacts."
  author="Arcade"
  authType="oauth2"
  authProviderName="Google"
  versions={["3.1.0"]}
/>

<Badges repo="arcadeai/arcade_google_contacts" />

The Arcade Google Contacts MCP Server provides a pre-built set of tools for interacting with Google Contacts. These tools make it easy to build agents and AI apps that can:

- Create new contacts
- Search for contacts by name or email

## Available Tools

These tools are currently available in the Arcade Google Contacts MCP Sever.

<TableOfContents
  headers={["Tool Name", "Description"]}
  data={[
    [
      "GoogleContacts.SearchContactsByEmail",
      "Search the user's contacts in Google Contacts by email address.",
    ],
    [
      "GoogleContacts.SearchContactsByName",
      "Search the user's contacts in Google Contacts by name.",
    ],
    [
      "GoogleContacts.SearchContactsByPhoneNumber",
      "Search the user's contacts in Google Contacts by phone number.",
    ],
    [
      "GoogleContacts.CreateContact",
      "Create a new contact record in Google Contacts.",
    ],
    [
      "GoogleContacts.WhoAmI",
      "Get comprehensive user profile and Google Contacts environment information.",
    ],
  ]}
/>

<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) with the [Google auth
  provider](/references/auth-providers/google#using-google-auth-in-custom-tools).
</Callout>

Each tool requires specific Google OAuth scopes to function. You'll find the required scopes listed in a blue info box at the end of each tool's documentation below. For more information about configuring OAuth and tips for moving to production, see the [Google auth provider documentation](/references/auth-providers/google.

## Find required scopes

Select the tools you plan to use to see the OAuth scopes your application needs:

<ScopePicker
  tools={[
    {
      name: "SearchContactsByEmail",
      scopes: ["https://www.googleapis.com/auth/contacts.readonly"],
    },
    {
      name: "SearchContactsByName",
      scopes: ["https://www.googleapis.com/auth/contacts.readonly"],
    },
    {
      name: "SearchContactsByPhoneNumber",
      scopes: ["https://www.googleapis.com/auth/contacts.readonly"],
    },
    {
      name: "CreateContact",
      scopes: ["https://www.googleapis.com/auth/contacts"],
    },
    {
      name: "WhoAmI",
      scopes: [
        "https://www.googleapis.com/auth/contacts.readonly",
        "https://www.googleapis.com/auth/userinfo.profile",
        "https://www.googleapis.com/auth/userinfo.email",
      ],
    },
  ]}
/>

---

## GoogleContacts.SearchContactsByEmail

Search the user's contacts in Google Contacts by email address.

<TabbedCodeBlock
  tabs={[
    {
      label: "Call the tool with user authorization",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/google/contacts/search_contacts_by_email_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/google/contacts/search_contacts_by_email_example_call_tool.js",
        ],
      },
    },
  ]}
/>

**Parameters**

- **`email`** _(string, required)_: The email address to search for.
- **`limit`** _(integer, optional)_: The maximum number of contacts to return (30 is the max allowed by the Google API).

<Callout type="info" title="This tool requires the following scope">
  `https://www.googleapis.com/auth/contacts.readonly`
</Callout>

---

## GoogleContacts.SearchContactsByName

Search the user's contacts in Google Contacts by name.

<TabbedCodeBlock
  tabs={[
    {
      label: "Call the tool with user authorization",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/google/contacts/search_contacts_by_name_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/google/contacts/search_contacts_by_name_example_call_tool.js",
        ],
      },
    },
  ]}
/>

**Parameters**

- **`name`** _(string, required)_: The full name to search for.
- **`limit`** _(integer, optional)_: The maximum number of contacts to return (30 is the max allowed by the Google API).

<Callout type="info" title="This tool requires the following scope">
  `https://www.googleapis.com/auth/contacts.readonly`
</Callout>

---

## GoogleContacts.CreateContact

Create a new contact record in Google Contacts.

<TabbedCodeBlock
  tabs={[
    {
      label: "Call the tool with user authorization",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/google/contacts/create_contact_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/google/contacts/create_contact_example_call_tool.js",
        ],
      },
    },
  ]}
/>

**Parameters**

- **`given_name`** _(string, required)_: The given name of the contact.
- **`family_name`** _(string, optional)_: The optional family name of the contact.
- **`email`** _(string, optional)_: The optional email address of the contact.
- **`phone_number`** _(string, optional)_: The optional phone_number address of the contact.

<Callout type="info" title="This tool requires the following scope">
  `https://www.googleapis.com/auth/contacts`
</Callout>

---

## GoogleContacts.WhoAmI

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool with User Authorization",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/google_contacts/who_am_i_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/google_contacts/who_am_i_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Get comprehensive user profile and Google Contacts environment information.

**Parameters**

This tool does not take any parameters.

<Callout type="info" title="This tool requires the following scopes">
  - `https://www.googleapis.com/auth/contacts.readonly`
  - `https://www.googleapis.com/auth/userinfo.profile`
  - `https://www.googleapis.com/auth/userinfo.email`
</Callout>

---

## Auth

The Arcade Google Contacts MCP Sever uses the [Google auth provider](/references/auth-providers/google to connect to users' Google accounts.

With the Arcade Cloud Platform, there's nothing to configure. Your users will see `Arcade` as the name of the application that's requesting permission.

With a self-hosted installation of Arcade, you need to [configure the Google auth provider](/references/auth-providers/google#configuring-google-auth) with your own Google app credentials.

<ToolFooter pipPackageName="arcade_google_contacts" />