Overview - Corsair

Use Bitbucket Cloud OAuth 2.0 through Corsair: one client, typed API calls, local DB sync. What you get:

104 typed API operations
11 synced entities (branches, commits, issues, pipelines, projects, pullRequests, and 5 more) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/bitbucket

yarn add corsair @corsair-dev/bitbucket

pnpm install corsair @corsair-dev/bitbucket

bun add corsair @corsair-dev/bitbucket

Add the plugin

corsair.ts

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

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

OAuth 2.0 (Recommended)

Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your Bitbucket Cloud OAuth 2.0 OAuth app.

bitbucket()

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

Example API calls

commitsAndInsights.getCommitBuildStatus

const tenant = corsair.withTenant('acme');
await tenant.bitbucket.api.commitsAndInsights.getCommitBuildStatus({});

commitsAndInsights.createRepositoriesCommitReportsAnnotations

const tenant = corsair.withTenant('acme');
await tenant.bitbucket.api.commitsAndInsights.createRepositoriesCommitReportsAnnotations({});

See the full list on the API page.

Query synced data

Synced entities support tenant.bitbucket.db.<entity>.search() and .list(): branches, commits, issues, pipelines, projects, pullRequests, repositories, snippets, tags, users, workspaces. See Database for filters and operators.

What’s next

API reference

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