Overview - Corsair

Use Neon through Corsair: one client, typed API calls, local DB sync. Neon exposes project, branch, database, role, compute endpoint, auth, organization, and infrastructure workflows for serverless Postgres. Use Corsair permissions for destructive actions such as deleting projects, dropping branches or databases, revoking API keys, or removing VPC endpoints. What you get:

110 typed API operations
8 synced entities (apiKeys, branches, computeEndpoints, databases, organizations, projects, and 2 more) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/neon

yarn add corsair @corsair-dev/neon

pnpm install corsair @corsair-dev/neon

bun add corsair @corsair-dev/neon

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		neon(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	hub: {
		projectApiKey: process.env.CORSAIR_DEV_API_KEY!,
		signingSecret: process.env.CORSAIR_DEV_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

API Key (Recommended)

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

neon()

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

Example API calls

apiKeys.listApiKeys

const tenant = corsair.withTenant('acme');
await tenant.neon.api.apiKeys.listApiKeys({});

apiKeys.createApiKey

const tenant = corsair.withTenant('acme');
await tenant.neon.api.apiKeys.createApiKey({});

See the full list on the API page.

Query synced data

Synced entities support tenant.neon.db.<entity>.search() and .list(): apiKeys, branches, computeEndpoints, databases, organizations, projects, roles, snapshots. See Database for filters and operators.

What’s next

API reference

Every neon.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