S2 Sdk Typescript

What s2-streamstore/s2-sdk-typescript MCP server does

The s2-streamstore/s2-sdk-typescript MCP server repository contains the official TypeScript SDK for S2. S2 is a managed data store for durable streams. Applications can add records to the tail of a stream, retrieve records by sequence number or timestamp, and follow new data as it arrives.

The SDK organizes access around basins and streams. A basin is a namespace that contains streams and supports basin-level operations. A stream client handles data-plane work such as appending records and reading them back. The package is published as @s2-dev/streamstore and is built on S2's REST API.

How it works

Create an S2 client with the access token and environment settings, then select a basin and stream. A stream can be created through the basin client before records are written. Append inputs contain one or more records, and records may use string or binary bodies with optional headers. Successful appends return acknowledgements containing sequence-number ranges; the example uses those coordinates to read the records back.

For ordered, higher-throughput writes, AppendSession keeps submitted batches in order and permits pipelining. It applies a configurable limit to unacknowledged bytes, providing backpressure while S2 confirms durability. Producer combines an append session with a batching transform that collects records for a configured interval or record count. The SDK also supports read sessions for reading beyond one response batch.

Setup and configuration

Install the package with npm, Yarn, or Bun:

npm add @s2-dev/streamstore

Create an S2 account, obtain an access key from the S2 dashboard, and create a basin. Set the access key in S2_ACCESS_TOKEN and the basin name in S2_BASIN. Examples may also use S2_STREAM to select a stream. The repository shows examples run with npx tsx, and its test command is bun run test.

A minimal client uses S2Environment.parse() together with the access token. From there, code can obtain a basin client, create a stream, append text or bytes, and issue a read with a sequence-number start and record-count limit.

Tools and capabilities

The documented SDK capabilities include:

• Creating and managing basins and streams through account and basin APIs.
• Appending batches containing string or binary records.
• Adding headers to records, including binary header values.
• Reading records by sequence number or timestamp.
• Following stream updates through the read APIs.
• Maintaining ordered append sessions with pipelining and backpressure.
• Batching records with configurable linger duration and maximum record count.
• Using browser examples and TypeScript application code.

Limitations and notes

The supplied material describes a TypeScript SDK rather than a documented MCP tool schema. It does not specify MCP transport details, exposed MCP tool names, or compatibility with Claude Desktop, Cursor, Windsurf, or Cline. Therefore, the s2-streamstore/s2-sdk-typescript MCP server should not be assumed to provide a ready-made MCP client integration based on this README alone.

The examples require an existing S2 account, access token, and basin. S2_STREAM is optional in the development examples, while S2_ACCESS_TOKEN and S2_BASIN are the documented core settings. The repository notes that releases before version 0.16.x are maintained in a separate repository.