Overview - Corsair

Use Nutshell through Corsair: one client, typed API calls. Authenticate with the Nutshell user’s email as the HTTP Basic username and that user’s API key as the password. Requests use the HTTPS REST API at https://app.nutshell.com/rest. This plugin implements the documented REST operations. Nutshell’s legacy JSON-RPC API is not included. Its webhooks are outbound notifications configured in Nutshell, not inbound operations for this integration. What you get:

114 typed API operations

Setup

Install

npm install corsair @corsair-dev/nutshell better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/nutshell better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/nutshell better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/nutshell better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		nutshell(),
	],
	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.

nutshell()

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

Example API calls

accounts.customFieldAttributes

const tenant = corsair.withTenant('acme');
await tenant.nutshell.api.accounts.customFieldAttributes({});

accounts.create

const tenant = corsair.withTenant('acme');
await tenant.nutshell.api.accounts.create({});

See the full list on the API page.

What’s next

API reference

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

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​What’s next