Connectors
Generated TypeScript SDK, MCP server, and CLI built on the same OpenAPI spec as this site.
Connectors
The broker's OpenAPI document is the contract for every client surface. Connectors are generated
or derived from
openapi/openapi.json,
not maintained by hand for each service.
Packages
| Package | Description | README |
|---|---|---|
@v2/sdk | Typed TypeScript client (openapi-typescript + openapi-fetch) | packages/sdk/README.md |
@v2/mcp | MCP server exposing API operations as tools | packages/mcp/README.md |
@v2/cli | Command-line interface on top of the SDK | packages/cli/README.md |
Each package follows the same naming rules as the API:
- operationId → tool / CLI command name (
linear_graphql,github_listPullRequests, …) - tags → service grouping (
linear,slack, …) x-write→ write gating in MCP and CLI (see Read vs write)
When to use which surface
- HTTP / REST — direct integration, webhooks, or languages without a generated client. Use this docs site's API reference.
- TypeScript SDK — application code inside the monorepo or Node services.
- MCP server — AI agents and editor tooling that expect MCP tools.
- CLI — ad hoc operations, scripts, and local debugging.
Regenerating after API changes
When the broker spec changes, regenerate the artifact and downstream connectors:
pnpm generateCommit the updated openapi/openapi.json and
packages/sdk/src/generated/internalApiPaths.ts artifacts. MCP and CLI copy the spec into their
build output; their package READMEs describe the runtime commands.
This documentation site
@v2/docs uses fumadocs-openapi to render operations from the same spec at build time. Adding a
service to the API requires no manual edits here. Run pnpm build (or pnpm dev), and the new
operations appear under API Reference.