@s2-dev/streamstore 0.3.14 → 0.4.2

package/README.md

@@ -72,6 +72,58 @@ yarn add @s2-dev/streamstore zod
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
 ```
+
+
+
+### Model Context Protocol (MCP) Server
+
+This SDK is also an installable MCP server where the various SDK methods are
+exposed as tools that can be invoked by AI applications.
+
+> Node.js v20 or greater is required to run the MCP server.
+
+<details>
+<summary>Claude installation steps</summary>
+
+Add the following server definition to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "S2": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@s2-dev/streamstore",
+        "--",
+        "mcp", "start",
+        "--bearer-auth", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Cursor installation steps</summary>
+
+Go to `Cursor Settings > Features > MCP Servers > Add new MCP server` and use the following settings:
+
+- Name: S2
+- Type: `command`
+- Command:
+```sh
+npx -y --package @s2-dev/streamstore -- mcp start --bearer-auth ... 
+```
+
+</details>
+
+For a full list of server arguments, run:
+
+```sh
+npx -y --package @s2-dev/streamstore -- mcp start --help
+```
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -88,7 +140,7 @@ The `S2Client` class provides a lot of convenience over the generated methods an
 ```typescript
 import { ReadRequest, S2Client } from "@s2-dev/streamstore";
 
-const s2 = new S2Client("<AUTH_TOKEN>");
+const s2 = new S2Client({ authToken: "<AUTH_TOKEN>" });
 
 async function run() {
   await s2.account.createBasin("my-favorite-basin");  
@@ -97,6 +149,67 @@ async function run() {
 
 run();
 ```
+### Examples
+
+- Using `S2Endpoints`
+
+```typescript
+const endpoints = new S2Endpoints(
+  "aws.s2.dev",
+  {
+      kind: BasinEndpointKind.Direct,
+      authority: "aws.s2.dev"
+  }
+);
+
+const s2 = new S2Client({ authToken: "<AUTH_TOKEN>", endpoints });
+async function run() {
+  const allStreams = await s2.account.basin("my-favorite-basin").listStreams();
+  for await (const stream of allStreams) {
+    console.log(basin);
+  }
+}
+
+run();
+```
+
+- Override Client level Auth token
+
+```typescript
+const s2 = new S2Client({ authToken: "<AUTH_TOKEN>"});
+async function run() {
+  const refreshedToken = await fetchToken();
+  await s2.account.deleteBasin("my-favorite-basin", { authToken: refreshedToken });
+}
+
+run();
+```
+
+- Set custom user-agent
+
+```typescript
+const s2 = new S2Client({ authToken: "<AUTH_TOKEN>", userAgent: "say-cheese" });
+async function run() {
+  const config = await s2.account.getBasinConfig("mehul-test");
+  console.log(config);
+}
+
+run();
+```
+
+- List Basins
+
+```typescript
+  const s2 = new S2Client({ authToken: "<AUTH_TOKEN>" });
+  async function run() {
+    const allBasins = await s2.account.listBasins();
+    for await (const basin of allBasins) {
+      console.log(basin);
+    }
+  }
+
+  run();
+```
 
 <!-- Start SDK Example Usage [usage] -->
 ## SDK Example Usage
@@ -448,7 +561,7 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { S2 } from "@s2-dev/streamstore";