Quick Start

Install

Generate your encryption key

Corsair encrypts every stored credential with a Key Encryption Key (KEK). Click to generate one and copy it into your .env:

Migrate the database

Corsair needs five tables. Run this once, then you're done.

sqlite3 corsair.db < migration.sql

Install GitHub plugin and create corsair.ts

This is the one file that wires everything together. Create it at src/server/corsair.ts:

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

const db = new Database('corsair.db');

export const corsair = createCorsair({
    plugins: [github()],
    database: db,
    kek: process.env.CORSAIR_KEK!,
});

You'll add more plugins here later — slack(), linear(), gmail() — same pattern, just append to the array.

Optional: Add your GitHub token and run setup

Use Corsair with any integration. Here's an example of how to get started with Github.

1. Go to GitHub → Settings → Developer settings → Personal access tokens (classic)
2. Click Generate new token (classic)
3. Select scopes: repo, read:org, read:user
4. Copy the token — it starts with ghp_

export GITHUB_TOKEN=ghp_...

Run setup once with the Corsair CLI:

Corsair stores your token, creates the database rows, and fetches your GitHub data locally. Your agent can now query it instantly — no API call needed every time.

Interact with Corsair

There's multiple ways to use Corsair. Here's two easy ways:

import Anthropic from '@anthropic-ai/sdk';
import { AnthropicProvider } from '@corsair-dev/mcp';
import { corsair } from './src/server/corsair';

async function main() {
    const provider = new AnthropicProvider();
    const tools = provider.build({ corsair });
    const client = new Anthropic();

    const message = await client.beta.messages.toolRunner({
        model: 'claude-sonnet-4-6',
        max_tokens: 4096,
        tools,
        messages: [{
            role: 'user',
            content: 'Use Corsair to list my GitHub repos with the most open issues.',
        }],
    });

    for (const block of message.content) {
        if (block.type === 'text') console.log(block.text);
    }
}

main().catch(console.error);

// Get a specific repo
const repo = await corsair.github.api.repositories.get({
    owner: 'octocat',
    repo: 'hello-world',
});

console.log(repo.name); // "hello-world"

// Every repo you've fetched — instant, no network
const repos = await corsair.github.db.repositories.search({});

// Filter in JS using camelCase data fields
const withIssues = repos.filter((r) => Number(r.data?.openIssuesCount ?? 0) > 0);

for (const repo of withIssues) {
    console.log(`${repo.data?.name} — ${repo.data?.openIssuesCount} open issues`);
}