Overview - Corsair

Use Dovetail through Corsair: one client, typed API calls, local DB sync. What you get:

51 typed API operations
13 synced entities (channels, contacts, data, dataPoints, docs, files, and 7 more) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/dovetail

yarn add corsair @corsair-dev/dovetail

pnpm install corsair @corsair-dev/dovetail

bun add corsair @corsair-dev/dovetail

Add the plugin

corsair.ts

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

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

With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

dovetail()

More: API Key

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: 'dovetail',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List projects

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

Create a note

const tenant = corsair.withTenant('acme');
await tenant.dovetail.api.notes.create({ project_id: 'proj_123', title: 'Customer interview', content: 'Notes from the call.' });

See the full list on the API page.

Query synced data

These tables exist, but Dovetail calls don’t fill them yet. This returns only rows you have written yourself.

const tenant = corsair.withTenant('acme');
const rows = await tenant.dovetail.db.projects.search({
	data: {},
	limit: 50,
});

Synced entities: channels, contacts, data, dataPoints, docs, files, folders, highlights, insights, notes, projects, tags, topics. See Database for filters and operators.

What’s next

API reference

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

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Query synced data

​What’s next