> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Stormboard plugin

> Stormboard turns unstructured collaboration into data-rich workspaces. This plugin manages storms and ideas with comments, votes, connectors, tags and tasks, handles chat and invitations, and reads the account profile behind the token.

Use **Stormboard** through Corsair: one client, typed API calls.

The API key sits on the API tab of the Stormboard account (stormboard.com/users/account#api) and authenticates with the X-API-Key header. Some operations need a paid subscription; the docs mark each route's availability (Public, Team Members, Team Owners), and on the free Personal plan storms.update, ideas.update, ideas.delete, votes and comments answer 401 "only available to Stormboard subscribers". The API uses standard rate-limiting headers (RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset) and answers 429 when the period quota is spent, which this plugin waits out before retrying. The two documented /templates routes answer an HTML 404 on the live API, so they are left out of this plugin; a team's template list is reachable through api.folders.list. Response examples mix numeric and string ids across routes, so id fields accept both.

**What you get:**

* 53 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/stormboard better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/stormboard better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/stormboard better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/stormboard better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { stormboard } from '@corsair-dev/stormboard';

export const corsair = createCorsair({
	plugins: [
		stormboard(),
	],
	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](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Stormboard API key before the first call: `pnpm corsair setup --plugin=stormboard --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> stormboard()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. 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](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'stormboard',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List your Storms**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.stormboard.api.storms.list({});
```

**Create an idea on a Storm**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.stormboard.api.ideas.create({});
```

See the full list on the [API](https://docs.corsair.dev/plugins/stormboard/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/stormboard/api.md)
>
> Every `stormboard.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.