Files
paperclip-docs/docs/connectors/gmail-setup.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

6.7 KiB

seo_title, seo_description
seo_title seo_description
Set Up the Gmail Connector Get Google Developer Preview access, connect Gmail with the read or draft capability group, and restrict which agents can search your mail.

Set up the Gmail connector

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.

Two phases: get Google to register you for Developer Preview, then connect. The first phase is the slow one and happens entirely at Google.

For what the connector can and cannot do once it is connected, see Gmail.

1. Get Developer Preview access

Google's Workspace MCP servers are in Developer Preview. Google registers both the Workspace email that will sign in and the Google Cloud project that owns the OAuth client. Registration covers only the emails and projects you name.

  1. Apply at Google Workspace Developer Preview with the Workspace email that will authorize Paperclip and the Google Cloud project that owns the OAuth client.
  2. Wait for the Google Group notification, then Google's final project-registration email. Google's guidance is usually a couple of days.
  3. Add every additional tester email and every additional Cloud project through Google's member request forms before connecting them. An unregistered account fails at authorization, not at connect time.

If you plan to use Connect with Paperclip rather than your own OAuth client, the Workspace email still has to be registered — the Cloud project on that path is Paperclip's.

2. If you are bringing your own OAuth client

Skip this section if your instance is enrolled with Paperclip Cloud and Connect with Paperclip is offered.

In the Google Cloud console:

  1. Enable the Gmail API and the Gmail MCP API on the project.
  2. Create an OAuth client of type Web application and add Paperclip's callback as an authorized redirect URI. Paperclip shows the exact URI during setup — copy it from there; it is the /api/tools/oauth/callback route on your instance's origin, and it must match exactly.
  3. Keep the client ID and client secret to hand.

Set up your own Google OAuth app covers this in full, including the redirect-URI failure mode, and is the same procedure for every other Google connector. Google's own walkthrough is Configure MCP servers.

3. Decide the capability group before you start

This is the decision that matters, and it is fixed for the life of the connection.

Group Scopes requested Use it when
Read only gmail.readonly Agents need to find and read mail. Nothing is written to the mailbox.
Read & create drafts gmail.readonly, gmail.compose An agent should leave a draft for a person to review and send.

Neither group makes sending reachable. 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 part of the connection, so Reconnect re-runs sign-in for the same group rather than changing it.

4. Connect

Setup asks for access first, then the credential.

  1. Select Connectors in the sidebar.
  2. Find Gmail and select Connect.
  3. On the Access step, choose the identity and which agents may use the connection:
    • Under Which humans can use this credential?, Just me is the usual answer for a mailbox — agents use the credential only on runs where you are the responsible person. An Organization identity makes one mailbox available on runs started by anyone in its human audience, which you set on the connection's identity card as either Any human in the company or Humans I pick with a named list. Narrow that audience for a mailbox: leaving it open means any colleague's run can read the inbox. It requires the connection-manager permission and suits a genuinely shared inbox, not a person's mail.
    • Under Which agents can use this connection, choose Just agents I pick and name them. A mailbox is not something to hand to every agent by default.
  4. Choose the capability group from step 3 and the setup path:
    • Connect with Paperclip — Paperclip's managed Google client. Offered only when the instance is enrolled with Paperclip Cloud and Cloud advertises the Gmail profile.
    • Use your own Google OAuth app — supply the client ID and secret from step 2.
  5. Complete Google's consent screen with the registered Workspace account.

5. Set the actions

Open the Permissions tab.

  • Leave the reads Allowed.
  • If you connected the draft group, consider setting create-draft to Ask first. Drafts land in a real mailbox, and the connector's own guidance recommends approval for them. This is advice, not something Paperclip enforces — unlike sending, which is blocked outright whatever you set.

6. Verify with a read

As the agent you intend to use, run one read whose answer you already know — a thread search against a sender you can see in Gmail — and confirm the result matches. This confirms the credential, the account, and the agent's permission together.

Then check the connection's activity shows the Gmail calls. Matching output alone does not establish that the mailbox was actually read.

Do not verify by creating a draft.

If authorization fails

Symptom Cause
Google refuses before the consent screen The signing-in Workspace account or the Cloud project is not registered for Developer Preview.
Connect with Paperclip is not offered The instance is not enrolled with Paperclip Cloud, or Cloud is not advertising the Gmail profile.
Consent completes but the connection shows Setup incomplete The final step was not finished. Select Finish setup.
Redirect URI mismatch The callback URI registered on your Google OAuth client does not match the one Paperclip displays.

More in Verify a connector and fix a broken one.