Overview - Corsair

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

52 typed API operations
11 synced entities (branches, comments, discussions, events, forks, issues, and 5 more) for fast .search() / .list()
100 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/github

yarn add corsair @corsair-dev/github

pnpm install corsair @corsair-dev/github

bun add corsair @corsair-dev/github

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		github({
			authType: 'managed',
		}),
	],
	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

Managed OAuth (Recommended)
API Key
OAuth 2.0

No setup required. Corsair hosts the OAuth app for GitHub — your tenants connect through Hub when they sign in.Provider walkthrough: Get Credentials.

github({
	authType: 'managed',
})

More: Managed OAuth

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

github()

More: API Key

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

github({
	authType: 'oauth_2',
})

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

Example API calls

List repositories

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

Create an issue

const tenant = corsair.withTenant('acme');
await tenant.github.api.issues.create({ owner: 'octocat', repo: 'hello-world', title: 'Found a bug' });

See the full list on the API page.

Query synced data

Search synced repositories without hitting GitHub.

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

Synced entities: branches, comments, discussions, events, forks, issues, pullRequests, releases, repositories, users, workflows. See Database for filters and operators.

Webhooks

Fires when a GitHub issue is opened.

github({
    webhookHooks: {
        issue: {
            opened: {
                after: async (ctx, result) => {
                    console.log('GitHub issue opened:', result.data);
                }
            },
        },
    },
})

Mount your framework handler once (see Frameworks), then point the provider at that URL. Full event list: Webhooks. Concepts: Webhooks, Hooks.

What’s next

API reference

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