Overview - Corsair

Use Google Drive through Corsair: one client, typed API calls, local DB sync, and incoming webhooks. What you get:

22 typed API operations
3 synced entities (files, folders, sharedDrives) for fast .search() / .list()
1 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/googledrive

yarn add corsair @corsair-dev/googledrive

pnpm install corsair @corsair-dev/googledrive

bun add corsair @corsair-dev/googledrive

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { googledrive } from '@corsair-dev/googledrive';

export const corsair = createCorsair({
	plugins: [
		googledrive(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

Multi-tenancy is the default — scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

OAuth 2.0 (Recommended)

Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your Google Drive OAuth app.Provider walkthrough: Get Credentials.

googledrive()

More: OAuth 2.0

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'googledrive',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List files

const tenant = corsair.withTenant('acme');
await tenant.googledrive.api.files.list({});

Create a file

const tenant = corsair.withTenant('acme');
await tenant.googledrive.api.files.createFromText({ name: 'hello.txt', content: 'Hello from Corsair' });

See the full list on the API page.

Query synced data

Search synced files without hitting Drive.

const tenant = corsair.withTenant('acme');
const rows = await tenant.googledrive.db.files.search({
	data: { trashed: false },
	limit: 50,
});

Synced entities: files, folders, sharedDrives. See Database for filters and operators.

Webhooks

Fires when a file or folder is created, updated, or deleted.

googledrive({
    webhookHooks: {
        driveChanged: {
            after: async (ctx, result) => {
                console.log('Drive change:', result.data?.changeType, result.data?.fileId ?? result.data?.folderId);
            }
        },
    },
})

Mount your framework handler once (see Frameworks). Corsair opens the Drive changes watch with that URL on connect. Drive has no console field for a webhook URL. Full event list: Webhooks. Concepts: Webhooks, Hooks.

What’s next

API reference

Every googledrive.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Webhooks

Event paths, payloads, and webhookHooks examples.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Get credentials

Provider-console walkthrough for keys and OAuth apps.

​Setup

​Example API calls

​Query synced data

​Webhooks

​What’s next

API reference

Database

Webhooks

Connect / OAuth

Use with agents

Get credentials

Setup

Example API calls

Query synced data

Webhooks

What’s next