> ## Documentation Index > Fetch the complete documentation index at: https://docs.formal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Gmail > Search email, summarize threads, and draft or send messages with governed access. Communication Publisher: Google Route Gmail MCP traffic through Formal to control and log what AI agents do in Gmail: * **Block** risky tools, such as `delete_label`. * **Mask** sensitive data in tool results, such as emails and phone numbers in `search_threads` responses. * **Keep credentials at the Connector**, so users and agents never see Gmail tokens. * **Log** every tool call with the user, the MCP client and its parameters. Cloud agents Laptop / VM Endpoint [https://gmailmcp.googleapis.com/mcp/v1](https://gmailmcp.googleapis.com/mcp/v1) Connector ![](https://docs.formal.ai/static/brands/gmail.png) ## 0. Prepare your Connector The Connector needs an MCP listener and a hostname with wildcard DNS and TLS. Set them up once by following [Deploy the Connector](https://docs.formal.ai/docs/guides/core-concepts/connectors/mcp-gateway.md#deploy-the-connector). Every MCP server reuses them. ## 1. Add Gmail MCP server to your Resources > [tab] UI > > 1. Open the [Admin Catalog](https://app.formal.ai/catalog) and click **Add MCP**. > 2. Select the **Gmail** template. > 3. Enter a DNS-label **Name**, such as `gmail`. > 4. Choose the **Space** containing your Connector, such as `default`. > 5. Configure upstream authentication as described below, then save. > > If no Connector is in the selected Space, the **Configuration** tab shows **MCP clients can't connect directly yet**. > The reason reads: `No Connector is in this server's Space.` > > Adding Gmail to the Admin Catalog > [tab] Terraform > > Set `space_id` to the ID of the Space containing your Connector. > > ```hcl theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > resource "formal_resource" "gmail" { > name = "gmail" > technology = "mcp" > hostname = "gmailmcp.googleapis.com" > space_id = "" > native_users_v3_enabled = true > port = 443 > tags = { > "mcp-endpoint" = "/mcp/v1" > } > } > > resource "formal_resource_oauth_settings" "gmail" { > resource_id = formal_resource.gmail.id > } > ``` > [tab] Pulumi > > Set `spaceId` to the ID of the Space containing your Connector. > > ```ts theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > import * as formal from "@formalco/pulumi"; > > const resource = new formal.Resource("mcp", { > name: "gmail", > technology: "mcp", > hostname: "gmailmcp.googleapis.com", > port: 443, > spaceId: "", > tags: { "mcp-endpoint": "/mcp/v1" }, > nativeUsersV3Enabled: true, > }); > > new formal.ResourceOauthSettings("mcpOAuth", { > resourceId: resource.id, > }); > ``` > [tab] API > > Create a Resource with the MCP endpoint and its Space ID. > > ```bash theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > export FORMAL_API_KEY="" > RESOURCE_RESPONSE=$(curl --fail --silent --show-error \ > --request POST \ > https://api.formal.ai/core.v1.ResourceService/CreateResource \ > --header "x-api-key: ${FORMAL_API_KEY}" \ > --header "Content-Type: application/json" \ > --data-binary @- < { > "name": "gmail", > "hostname": "gmailmcp.googleapis.com", > "port": 443, > "technology": "mcp", > "spaceId": "", > "tags": [ > { > "key": "mcp-endpoint", > "value": "/mcp/v1" > } > ] > } > JSON > ) > RESOURCE_ID=$(printf '%s' "${RESOURCE_RESPONSE}" | jq -r '.resource.id') > curl --fail --silent --show-error \ > --request POST \ > https://api.formal.ai/core.v1.ResourceService/CreateResourceOAuthSettings \ > --header "x-api-key: ${FORMAL_API_KEY}" \ > --header "Content-Type: application/json" \ > --data-binary @- < { > "resourceId": "${RESOURCE_ID}" > } > JSON > ``` ## 2. Setup Authentication > [tab] Linked Accounts (Recommended) > > Each user links their own Gmail account once in the Employee Catalog, and the Connector sends that user's token to Gmail. > > ![Linked Accounts selected under How does Formal authenticate to this resource?](https://mintcdn.com/formal/vzPMpIcsF4BYmdx8/assets/images/mcp-servers/auth-linked-accounts.png?fit=max\&auto=format\&n=vzPMpIcsF4BYmdx8\&q=85\&s=dc448db2a373faa6e1bf49fd5ffaf7c4) > > Gmail doesn't support Formal's App, so register your own OAuth app. > > See [Gmail OAuth documentation](https://developers.google.com/workspace/gmail/api/guides/configure-mcp-server) and [register an app](https://console.cloud.google.com/auth/clients/create). > > **1. Enable the APIs** > > In your Google Cloud project, enable the **Gmail API** and the **Gmail MCP API**. > > **2. Configure the consent screen** > > Go to **Google Auth Platform** > **Branding** and click **Get Started**. Under **Audience**, select **Internal** if available. > > **3. Choose scopes** > > In **Data Access**, click **Add or Remove Scopes**. Paste the Gmail scopes under **Manually add scopes**, then click **Update** and **Save**. > > **4. Create the client** > > Go to **Clients** > [**Create Client**](https://console.cloud.google.com/auth/clients/create) and select **Web application**. Under **Authorized redirect URIs**, click **+ Add URI** and paste Formal's **Redirect URI**. > > **5. Copy the credentials** > > Select **Use this client for an AI-powered agent**, click **Create**, and copy the **Client ID** and **Client secret**. > > **6. Enter the app in Formal** > > > [tab] UI > > > > Back in the Admin Catalog, enter the **Client ID** and **Client secret**, then save. > > Users then link their accounts on the Gmail server's page in the [Employee Catalog](https://catalog.formal.ai). > > > > ![Your OAuth App selected in the Admin Catalog, with the Redirect URI, Client ID and Client secret fields](https://mintcdn.com/formal/R-3CwVgs8IU6liji/assets/images/mcp-servers/your-oauth-app.png?fit=max\&auto=format\&n=R-3CwVgs8IU6liji\&q=85\&s=00584678f4f2696805678de060eaea0a) > > > [tab] Terraform > > > > Use these OAuth settings instead of the ones from step 1. > > > > ```hcl theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > > variable "gmail_oauth_client_secret" { > > type = string > > sensitive = true > > } > > > > resource "formal_resource_oauth_settings" "gmail" { > > resource_id = formal_resource.gmail.id > > upstream_oauth_mode = "pre_registered" > > client_id = "" > > client_secret_wo = var.gmail_oauth_client_secret > > client_secret_wo_version = 1 > > } > > ``` > > > [tab] Pulumi > > > > Use these OAuth settings instead of the ones from step 1. > > Store the secret with `pulumi config set --secret gmailOauthClientSecret`. > > > > ```ts theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > > import * as pulumi from "@pulumi/pulumi"; > > > > const config = new pulumi.Config(); > > > > new formal.ResourceOauthSettings("mcpOAuth", { > > resourceId: resource.id, > > upstreamOauthMode: "pre_registered", > > clientId: "", > > clientSecret: config.requireSecret("gmailOauthClientSecret"), > > }); > > ``` > > > [tab] API > > > > Use this call instead of the `CreateResourceOAuthSettings` call from step 1. > > The OAuth app is fixed at creation. > > > > ```bash theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > > curl --fail --silent --show-error \ > > --request POST \ > > https://api.formal.ai/core.v1.ResourceService/CreateResourceOAuthSettings \ > > --header "x-api-key: ${FORMAL_API_KEY}" \ > > --header "Content-Type: application/json" \ > > --data-binary @- < > { > > "resourceId": "${RESOURCE_ID}", > > "upstreamOauthMode": "pre_registered", > > "clientId": "", > > "clientSecret": "" > > } > > JSON > > ``` > [tab] Shared Credentials > > An administrator stores one Gmail token in Formal, and the Connector sends it on every user's requests without showing it to them. > > ![Shared Credentials selected under How does Formal authenticate to this resource?](https://mintcdn.com/formal/R-3CwVgs8IU6liji/assets/images/mcp-servers/auth-shared-credentials.png?fit=max\&auto=format\&n=R-3CwVgs8IU6liji\&q=85\&s=91032e202518088292ee1cf39451b9ef) > > Gmail's MCP endpoint doesn't accept API tokens, so use Linked Accounts. > [tab] Pass Through > > Each user sends their own Gmail sign-in or token from their MCP client, and Formal forwards it unchanged without storing it. > > ![Pass Through selected under How does Formal authenticate to this resource?](https://mintcdn.com/formal/R-3CwVgs8IU6liji/assets/images/mcp-servers/auth-pass-through.png?fit=max\&auto=format\&n=R-3CwVgs8IU6liji\&q=85\&s=c14ae61de2dba8b567626cba03aae2cf) > > Nothing in the request identifies the Formal user. Formal attributes these requests only when they come through the [Formal Endpoint](https://docs.formal.ai/docs/guides/core-concepts/connectors/mcp-gateway.md#identity-headers). Pass-through servers have no Connector address, so cloud agents can't use them. > > For OAuth, each MCP client signs in to Gmail itself. ## 3. Route Endpoint traffic Auth is managed at the Connector level when you use Linked Accounts or Shared Credentials, so the Endpoint needs to forward the MCP traffic to it. Laptops and VMs with the Formal Endpoint keep using `https://gmailmcp.googleapis.com/mcp/v1`, and a network rule sends that traffic to the Connector. > [tab] UI > > 1. Go to [Network Rules](https://app.formal.ai/network-rules) and create a rule named `gmail-mcp`. > 2. Paste this expression, set the rule to **Active**, then save: > > ```javascript theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > { > "condition": { > "pre_tcp": process.is_agent, > // Every MCP server added to Formal: process.is_agent && resource.technology == "mcp" > "pre_tls": process.is_agent && hostname == "gmailmcp.googleapis.com", > "post_tls": true > }, > "outputs": { > "forward_to_connector": true > } > } > ``` > [tab] Terraform > > ```hcl theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > resource "formal_network_rule" "gmail_mcp" { > name = "gmail-mcp" > description = "Forward Gmail MCP traffic from agents to the Connector" > status = "active" > > # Every MCP server added to Formal: set pre_tls to process.is_agent && resource.technology == "mcp" > cel_expression = <<-EOT > { > "condition": { > "pre_tcp": process.is_agent, > "pre_tls": process.is_agent && hostname == "gmailmcp.googleapis.com", > "post_tls": true > }, > "outputs": { > "forward_to_connector": true > } > } > EOT > } > ``` > [tab] Pulumi > > ```ts theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > import * as formal from "@formalco/pulumi"; > > new formal.NetworkRule("gmailMcp", { > name: "gmail-mcp", > description: "Forward Gmail MCP traffic from agents to the Connector", > status: "active", > // Every MCP server added to Formal: set pre_tls to process.is_agent && resource.technology == "mcp" > celExpression: ` > { > "condition": { > "pre_tcp": process.is_agent, > "pre_tls": process.is_agent && hostname == "gmailmcp.googleapis.com", > "post_tls": true > }, > "outputs": { > "forward_to_connector": true > } > } > `, > }); > ``` > [tab] API > > ```bash theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > export FORMAL_API_KEY="" > # Every MCP server added to Formal: set pre_tls to process.is_agent && resource.technology == "mcp" > CEL_EXPRESSION=$(cat <<'CEL' > { > "condition": { > "pre_tcp": process.is_agent, > "pre_tls": process.is_agent && hostname == "gmailmcp.googleapis.com", > "post_tls": true > }, > "outputs": { > "forward_to_connector": true > } > } > CEL > ) > jq -n --arg cel "${CEL_EXPRESSION}" '{ > name: "gmail-mcp", > description: "Forward Gmail MCP traffic from agents to the Connector", > status: "active", > celExpression: $cel > }' | curl --fail --silent --show-error \ > --request POST \ > https://api.formal.ai/core.v1.DesktopService/CreateDesktopRoutingRule \ > --header "x-api-key: ${FORMAL_API_KEY}" \ > --header "Content-Type: application/json" \ > --data-binary @- > ``` The rule matches [known agents](https://docs.formal.ai/docs/guides/network-rules.md#known-agent-identities) only. See [Identity headers](https://docs.formal.ai/docs/guides/core-concepts/connectors/mcp-gateway.md#identity-headers). Cloud agents such as Claude, ChatGPT and Cursor Cloud Agents don't run the Endpoint. Point them at this server's Connector address, `https://gmail./mcp`. Find it in the [Admin Catalog](https://app.formal.ai/catalog): open Gmail, then copy **Connector address** on the **Configuration** tab. ## 4. Create policies ### Tools The Admin Catalog lists these tools for Gmail: | Tool | Description | | - | - | | `search_threads` | Search Gmail conversations. | | `get_thread` | Retrieve a complete email thread. | | `get_message` | Retrieve an email message. | | `send_message` | Send an email message. | | `reply` | Reply to an email thread. | | `forward` | Forward an email message. | | `create_draft` | Create an email draft. | | `list_drafts` | List saved drafts. | | `trash_message` | Move a message to trash. | | `trash_thread` | Move a thread to trash. | | `list_labels` | List Gmail labels. | | `create_label` | Create a Gmail label. | | `delete_label` | Delete a Gmail label. | | `label_message` | Apply a label to a message. | | `unlabel_message` | Remove a label from a message. | | `label_thread` | Apply a label to a thread. | | `unlabel_thread` | Remove a label from a thread. | | `apply_sensitive_message_label` | Mark a message with the configured sensitive label. | | `apply_sensitive_thread_label` | Mark a thread with the configured sensitive label. | | `mark_message_spam` | Mark a message as spam. | | `unmark_message_spam` | Remove the spam classification from a message. | | `mark_thread_spam` | Mark a thread as spam. | | `unmark_thread_spam` | Remove the spam classification from a thread. | | `list_filters` | List Gmail filters. | | `create_filter` | Create a Gmail filter. | ### Policies examples > [tab] Block a tool > > This policy blocks the tools that change data, so agents can only read Gmail. > > ```rego theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > package formal.v2 > > import future.keywords.if > import future.keywords.in > > write_tools := { > "send_message", > "reply", > "forward", > "create_draft", > "trash_message", > "trash_thread", > "create_label", > "delete_label", > "label_message", > "unlabel_message", > "label_thread", > "unlabel_thread", > "apply_sensitive_message_label", > "apply_sensitive_thread_label", > "mark_message_spam", > "unmark_message_spam", > "mark_thread_spam", > "unmark_thread_spam", > "create_filter", > } > > request := { > "action": "block", > "type": "block_with_custom_message", > "message": "Writing to Gmail is not allowed.", > } if { > input.resource.name == "gmail" > input.mcp.method == "tools/call" > input.mcp.tool_name in write_tools > } > ``` > [tab] Mask a tool's output > > This policy replaces email addresses in results returned by `search_threads`, `get_thread`, and `get_message`. > > ```rego theme={"languages":{"custom":["/languages/cel.json","/languages/rego.json"]}} > package formal.v2 > > import future.keywords.if > import future.keywords.in > > email_pattern := `[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}` > > response := { > "action": "rewrite", > "body": regex.replace(input.http.body, email_pattern, "[REDACTED-EMAIL]"), > "reason": "Mask emails in Gmail results", > } if { > input.resource.name == "gmail" > input.mcp.tool_name in {"search_threads", "get_thread", "get_message"} > regex.match(email_pattern, input.http.body) > } > ``` See [MCP resources](https://docs.formal.ai/docs/guides/policies/evaluation.md#mcp-resources) for the `input.mcp` fields and [Rewrite Action](https://docs.formal.ai/docs/guides/policies/enforcement.md#rewrite-action) for body rewrites. ## 5. Check the logs Open [Logs](https://app.formal.ai/logs) and search for `resource.name:gmail`. Each Gmail tool call is one `request` log with the user, the MCP client and the tool. Open a log to see its tool parameters and the policies it triggered. A blocked write shows the block policy and its message. A masked search shows the rewrite policy. Gmail tool calls in Logs, including a masked response and a blocked write See [Logs](https://docs.formal.ai/docs/guides/observability/logs.md) for search syntax and filters. ## Troubleshooting > [accordion] The agent says Formal has no current sign-in > > The agent relays: `Formal has no current gmail sign-in for you. Link or re-link your gmail account in Formal…` > > **Cause:** The user never linked Gmail, or the token expired and couldn't be refreshed. > > **Fix:** Open the server in the [Employee Catalog](https://catalog.formal.ai) and link Gmail again. > [accordion] The agent says Gmail rejected your credentials > > The agent relays: `gmail rejected your credentials. Link or re-link your gmail account in Formal…` > > **Cause:** Gmail no longer accepts the linked token, for example after the user revoked access in Gmail. > > **Fix:** Link Gmail again from the [Employee Catalog](https://catalog.formal.ai). > [accordion] Laptop traffic doesn't appear in Logs > > **Cause:** The Endpoint isn't running, or the network rule doesn't match the client. > > **Fix:** Check the Endpoint is connected. The rule above only matches [known agents](https://docs.formal.ai/docs/guides/network-rules.md#known-agent-identities). Other clients, such as a browser, reach Gmail directly unless the rule also matches them. See [Network rules](https://docs.formal.ai/docs/guides/network-rules.md). > [accordion] MCP clients can't connect directly yet > > **Cause:** The **Configuration** tab lists the reason, most often `No Connector is in this server's Space.` > > **Fix:** Edit the server and choose the Space containing its Connector. ## Next Steps > [card] [MCP Gateway](https://docs.formal.ai/docs/guides/core-concepts/connectors/mcp-gateway.md) > > Configure Connector routing and downstream access > [card] [All MCP servers](https://docs.formal.ai/docs/guides/core-concepts/connectors/mcp-servers/index.md) > > Browse every MCP server template This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.