Files
paperclip-docs/docs/connectors/gmail.md
T
39633c2217 docs: connectors catalog, operator-first third revision (#124)
Connector catalog, setup guides, and shared access documentation,
followed by a final code-accuracy repair pass. This PR does not change
application behavior.

## Final accuracy pass

Checked against shipped Paperclip `v2026.916.0`, commit
`dffc2b3ca1b9e88fa21cb17493083e682dffd1ca`, rather than the dirty local
checkout or the earlier canary baseline.

- Corrects connector/method-specific identity choices, human audiences,
and managed GitHub versus PAT scope and verification.
- Explains that **Always allow** covers different arguments for the same
agent/action/connection, with project scope when present; uses actual
button labels and removes the test-panel control from review
instructions.
- Qualifies new-action quarantine, including safe-default read
exceptions. Removes unconditional approval guarantees.
- Separates provider channel/repository reach from Paperclip sender
authorization.
- Completes sandbox sign-in and model credential-selection instructions
from the current UI implementation.
- Repairs Notion's hub summary, removes incomplete optional
Notion/Sentry client-registration procedures, and corrects Linear's
provider-versus-Paperclip attribution.
- Removes unsupported Postman tier claims, contradictory Cloudinary/Mem0
verification assertions, API-equivalence claims, and overbroad
successful-test assurances.
- Retains Supabase's required project reference: both released method
definitions explicitly require it. An earlier review suggested
otherwise; release code is authoritative here.
- Updates the release baseline and removes draft commit chronology from
the public introduction.

## Availability and remaining runtime gates

- **Google:** Verification is pending. Per the product-owner
clarification, authorization can continue where Google offers an
Advanced option; this is not available for every account and does not
override Workspace policy or other Google prerequisites. Notices on the
hub and all Google guides now distinguish an unverified-app warning from
blocked authorization.
- **Slack is available but not yet fully functional; follow-up fixes are
planned.** For agent tools, the released OAuth endpoint/scope defaults
differ from Slack's documented MCP contract. The page now warns against
treating that route as production-ready and removes the misleading
bot-scope walkthrough. Chat-channel bot setup remains separate.
Engineering must reconcile the integration and run OAuth plus one read
before removing this warning. Source:
https://docs.slack.dev/ai/slack-mcp-server/
- No credentialed connector run was performed in this pass. Code
consistency, provider documentation, UI rendering, and successful live
execution are separate evidence levels. No claim of runtime
certification for all connectors.

## Validation

- Root build: 253 crawlable documentation pages.
- Full `docs:test`: all eight suites passed locally, including
root/subpath routes, sitemap history, fingerprints, navigation, skill
source blocks, crawlable links, doc-link resolution, and SEO metadata.
- Internal-link lint: 258 Markdown files; no broken internal links.
- Latest cleanup: full build, all eight docs:test suites, internal-link
lint and diff whitespace checks passed; 1,878 link-resolution checks.
- Fixed the Calendar MCP reference URL; browser-checked the five
inconclusive external destinations (Miro article loads; Asana, Google
Cloud, OpenAI and xAI reach sign-in/console screens). Authenticated
destinations were not tested beyond those screens.
- Replaced the Sandbox providers editorial TODO with a scope note and
removed the CLI overview's unfinished-guide announcement.
- Browser client navigation: 687 checks passed using installed Chrome.
Initial launch lacked the downloaded Playwright browser; rerun used
`DOCS_CHROMIUM_PATH` without changing the tests.
- Nine representative connector/shared pages at 1440px and 390px: HTTP
200, one article H1, no page-level horizontal overflow. Mobile
screenshot inspected; approval page opened in the Codex browser.
- Navigation audit reports three existing non-connector orphan files;
this patch does not alter those files or their navigation.

The previous revision's provider-page expansion, Google shared setup
guide, navigation additions, and accidental node_modules-symlink cleanup
remain in this PR. Internal review ledgers remain outside the
publication branch. No merge or production deployment authorized.

---------

Co-authored-by: DevRel Gemini <[email protected]>
Co-authored-by: Paperclip <[email protected]>
Co-authored-by: Claude Opus 5 (1M context) <[email protected]>
Co-authored-by: Michael Nguyen <[email protected]>
2026-09-16 22:19:14 -10:00

7.3 KiB

seo_title, seo_description
seo_title seo_description
Gmail Connector Let agents search and read Gmail, and optionally draft replies. Sending is not reachable. Setup choices, access scope, a read test, and fixes.

Gmail

Warning: Google verification pending. Paperclip has not yet completed Google app verification. You may see an unverified-app warning during authorization. If Google offers an Advanced option to continue to Paperclip, you can choose to proceed after reviewing the requested access. This option is not available for every account; Workspace administrator restrictions and other Google access requirements still apply. Contact [email protected] if you cannot connect.

Agents can search and read your Gmail, and on a draft connection leave drafts in your drafts folder for you to review. Sending is not reachable through this connector.

Warning: Gmail needs Google Workspace Developer Preview registration before it will authorize. Google must register the Workspace email that signs in, and — if you bring your own OAuth client — the Cloud project that owns it. Apply first: Google Workspace Developer Preview.

Set up the Gmail connector is the step-by-step procedure. This page explains what you are choosing and what the connection can reach.

Pick a capability group

One decision matters more than the rest, and it is fixed for the life of the connection.

Group What agents can do Scopes requested
Read only Search and read messages, threads, drafts, and labels gmail.readonly
Read & create drafts The above, plus create a draft for a person to review and send gmail.readonly, gmail.compose

Start with Read only unless you have a concrete reason for drafts. To change groups later, create a second connection with the group you want and remove the first; the group is not a switch on an existing connection.

Why sending is not reachable

This is worth stating precisely, because the credential and the enforcement are different things.

Google's gmail.compose scope, which the draft group requests, does permit sending at Google's end. Paperclip does not rely on the scope to prevent it. A Google Workspace connection is limited to a reviewed list of operations, and anything outside that list is switched off rather than merely unpermitted. For Gmail the reviewed write list is exactly one operation, create-draft.

The practical effect: no action setting, capability group, or approved review request produces a sent message, and a send-like operation that Google adds to the server later is off by default rather than newly available. If mail must go out, a person sends the draft from Gmail.

What agents can actually do

Operation Group
search-threads, list-threads, get-thread Both
search-messages, get-message Both
list-drafts, get-draft, list-labels Both
create-draft Read & create drafts only

Operation names are normalized before matching, so a provider variant such as google.gmail/get_message resolves to the same entry. The live list for your connection is on its Permissions tab, and Refresh actions re-reads it. Anything Google adds that is not on the reviewed list comes back disabled — that block is what the reviewed list enforces, and it holds however the connection was created.

Note: This is Paperclip's reviewed list, not a promise about Google's server. Google supplies the catalog and can change it; the reviewed list is what Paperclip will enable from it.

Choose access

Gmail is a mailbox, so the identity question is unusually consequential.

  • Just me is the usual answer. The credential is yours and agents use it only on runs where you are the responsible person.
  • An Organization identity makes one mailbox readable by eligible agents on runs whose responsible person is in the credential's human audience. That suits a shared support inbox and not a person's mail. It needs the connection-manager permission.

Under Which agents can use this connection, prefer Just agents I pick. A mailbox is not a good default for every agent in the company.

On the Permissions tab, leave the reads Allowed. On a draft connection, set create-draft to Ask first — a draft lands in a real mailbox, and the connector's own guidance is that draft creation should be approved. How connector access works covers the model; Set action permissions is the how-to.

Google-side controls still apply on top: a Workspace administrator can restrict which third-party apps may hold Gmail scopes, and revoking the grant in your Google account stops the connection regardless of Paperclip's settings.

Try it

Run one read whose answer you already know, as the agent you intend to use:

Search my Gmail for the most recent message from our domain registrar and tell me its subject and date.

Compare the subject and date against Gmail. That confirms the credential, the account, and the agent's permission in one step, and leaves nothing behind.

Then open the connection's activity and confirm the Gmail calls are recorded there. A plausible subject line is not by itself evidence the mailbox was read — the activity record is what distinguishes a retrieved message from a confident guess.

Do not verify with a draft. A draft is a write and it puts something in a real mailbox.

Note: Illustrative task, not a recorded test result. Use a query you can confirm by eye.

Troubleshooting and limitations

Problem Likely cause Fix
Google refuses before the consent screen The signing-in Workspace account, or the Cloud project on a self-managed client, is not registered for Developer Preview Complete registration, including every additional tester email, then retry
Connect with Paperclip is not offered The instance is not enrolled with Paperclip Cloud, or Cloud is not advertising the Gmail profile Use Use your own Google OAuth app, or ask an administrator about enrollment
create-draft is absent The connection was made with Read only Create a connection with the draft group
A send or trash operation is absent Expected — it is outside the reviewed list Nothing to fix. There is no supported send path
Consent succeeds but the connection shows Setup incomplete The last step was not finished Select Finish setup
Needs attention with a reconnect prompt The Google token expired or the grant was revoked Select Reconnect

Limitations: one connection reaches one mailbox. Deleting, trashing, marking spam, and changing labels are not available in either group. Google's Workspace MCP servers remain in Developer Preview, so treat the surface as subject to change.