Skip to content
This repository was archived by the owner on Oct 23, 2025. It is now read-only.

Commit b3c15d6

Browse files
Merge pull request #15 from s2-streamstore/speakeasy-sdk-regen-1743207618
chore: 🐝 Update SDK - Generate 0.9.0
2 parents a2539ac + de36e26 commit b3c15d6

File tree

27 files changed

+267
-77
lines changed

27 files changed

+267
-77
lines changed

.speakeasy/gen.lock

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: 2d20490e-9921-47d5-9711-d3c4b91c8cfa
33
management:
4-
docChecksum: 251ce21fe3119a7e2fdc7dde8bb95189
4+
docChecksum: fc7ccff916d1497e4fbe77990764c0ea
55
docVersion: 1.0.0
6-
speakeasyVersion: 1.517.3
7-
generationVersion: 2.548.6
8-
releaseVersion: 0.8.3
9-
configChecksum: 42f6043385d43164ab24ab90706185aa
6+
speakeasyVersion: 1.526.0
7+
generationVersion: 2.563.0
8+
releaseVersion: 0.9.0
9+
configChecksum: bfa897245f346d77875e02c12964ae72
1010
repoURL: https://github.com/s2-streamstore/s2-sdk-typescript.git
1111
installationURL: https://github.com/s2-streamstore/s2-sdk-typescript
1212
published: true
@@ -23,7 +23,7 @@ features:
2323
globalSecurityCallbacks: 0.1.0
2424
globalSecurityFlattening: 0.1.0
2525
globalServerURLs: 2.82.4
26-
mcpServer: 0.7.0
26+
mcpServer: 0.9.0
2727
methodServerURLs: 2.82.1
2828
nullables: 0.1.1
2929
pagination: 2.83.0
@@ -146,6 +146,7 @@ generatedFiles:
146146
- src/mcp-server/console-logger.ts
147147
- src/mcp-server/extensions.ts
148148
- src/mcp-server/mcp-server.ts
149+
- src/mcp-server/prompts.ts
149150
- src/mcp-server/resources.ts
150151
- src/mcp-server/scopes.ts
151152
- src/mcp-server/server.ts

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ generation:
1818
oAuth2ClientCredentialsEnabled: true
1919
oAuth2PasswordEnabled: true
2020
typescript:
21-
version: 0.8.3
21+
version: 0.9.0
2222
additionalDependencies:
2323
dependencies:
2424
uuid: ^9.0.1

.speakeasy/workflow.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.517.3
1+
speakeasyVersion: 1.526.0
22
sources:
33
S2 API:
44
sourceNamespace: s-2-api
5-
sourceRevisionDigest: sha256:fcd4b4ca21591d24e1e05f4cc8b37dd7c38d86f36fcdc0f3c7c893ab8d537ed2
6-
sourceBlobDigest: sha256:1b3ef0abca7bf3448a722a6adebea3597b9a668c75a63d90603864a217268e6b
5+
sourceRevisionDigest: sha256:f1d83361916b35822f541e0a01c355dde95ef6e49e35e64fd3d4cf7deb9e4aa2
6+
sourceBlobDigest: sha256:9d293d7de1fd49273a04610c968cb7bc5b2523af81c04810beb7fb327eb20b42
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1741998020
9+
- speakeasy-sdk-regen-1743207618
1010
- 1.0.0
1111
targets:
1212
streamstore:
1313
source: S2 API
1414
sourceNamespace: s-2-api
15-
sourceRevisionDigest: sha256:fcd4b4ca21591d24e1e05f4cc8b37dd7c38d86f36fcdc0f3c7c893ab8d537ed2
16-
sourceBlobDigest: sha256:1b3ef0abca7bf3448a722a6adebea3597b9a668c75a63d90603864a217268e6b
15+
sourceRevisionDigest: sha256:f1d83361916b35822f541e0a01c355dde95ef6e49e35e64fd3d4cf7deb9e4aa2
16+
sourceBlobDigest: sha256:9d293d7de1fd49273a04610c968cb7bc5b2523af81c04810beb7fb327eb20b42
1717
codeSamplesNamespace: s-2-api-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:542fbebe7a67b84c69a7e1ed24d219a598f4e8bf344da52e7b86eef006781e2a
18+
codeSamplesRevisionDigest: sha256:8574a5eb372a1e15b92defed0cee747557e9c0541a2b0d8e4ff1348f7112f24b
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

README.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ yarn add @s2-dev/streamstore zod
8282
This SDK is also an installable MCP server where the various SDK methods are
8383
exposed as tools that can be invoked by AI applications.
8484

85-
> Node.js v20 or greater is required to run the MCP server.
85+
> Node.js v20 or greater is required to run the MCP server from npm.
8686
8787
<details>
8888
<summary>Claude installation steps</summary>
@@ -110,17 +110,50 @@ Add the following server definition to your `claude_desktop_config.json` file:
110110
<details>
111111
<summary>Cursor installation steps</summary>
112112

113-
Go to `Cursor Settings > Features > MCP Servers > Add new MCP server` and use the following settings:
113+
Create a `.cursor/mcp.json` file in your project root with the following content:
114114

115-
- Name: S2
116-
- Type: `command`
117-
- Command:
118-
```sh
119-
npx -y --package @s2-dev/streamstore -- mcp start --bearer-auth ...
115+
```json
116+
{
117+
"mcpServers": {
118+
"S2": {
119+
"command": "npx",
120+
"args": [
121+
"-y", "--package", "@s2-dev/streamstore",
122+
"--",
123+
"mcp", "start",
124+
"--bearer-auth", "..."
125+
]
126+
}
127+
}
128+
}
120129
```
121130

122131
</details>
123132

133+
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
134+
135+
```bash
136+
curl -L -o mcp-server \
137+
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
138+
chmod +x mcp-server
139+
```
140+
141+
If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
142+
143+
144+
```json
145+
{
146+
"mcpServers": {
147+
"Todos": {
148+
"command": "./DOWNLOAD/PATH/mcp-server",
149+
"args": [
150+
"start"
151+
]
152+
}
153+
}
154+
}
155+
```
156+
124157
For a full list of server arguments, run:
125158

126159
```sh

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,14 @@ Based on:
8888
### Generated
8989
- [typescript v0.8.3] .
9090
### Releases
91-
- [NPM v0.8.3] https://www.npmjs.com/package/@s2-dev/streamstore/v/0.8.3 - .
91+
- [NPM v0.8.3] https://www.npmjs.com/package/@s2-dev/streamstore/v/0.8.3 - .
92+
93+
## 2025-03-30 00:22:44
94+
### Changes
95+
Based on:
96+
- OpenAPI Doc
97+
- Speakeasy CLI 1.526.0 (2.563.0) https://github.com/speakeasy-api/speakeasy
98+
### Generated
99+
- [typescript v0.9.0] .
100+
### Releases
101+
- [NPM v0.9.0] https://www.npmjs.com/package/@s2-dev/streamstore/v/0.9.0 - .

docs/models/components/batch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Batch
22

33
Batch of records.
4-
This batch can be empty only if a `ReadLimit` was provided in the associated read request, but the first record
5-
that could have been returned would violate the limit.
4+
It can only be empty when not in a session context (which implies a limit),
5+
if the first record that could have been retrieved would violate the limit.
66

77
## Example Usage
88

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# FirstSeqNum
22

3-
Sequence number for the first record on this stream, in case the requested `start_seq_num` is smaller.
4-
If returned in a streaming read session, this will be a terminal reply, to signal that there is uncertainty about whether some records may be omitted.
5-
The client can re-establish the session starting at this sequence number.
3+
Sequence number for the first record on this stream.
4+
Typically this will be returned when the requested `start_seq_num` was smaller.
5+
It may also be returned during a session, if the stream gets concurrently trimmed.
66

77
## Example Usage
88

@@ -16,6 +16,6 @@ let value: FirstSeqNum = {
1616

1717
## Fields
1818

19-
| Field | Type | Required | Description |
20-
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21-
| `firstSeqNum` | *number* | :heavy_check_mark: | Sequence number for the first record on this stream, in case the requested `start_seq_num` is smaller.<br/>If returned in a streaming read session, this will be a terminal reply, to signal that there is uncertainty about whether some records may be omitted.<br/>The client can re-establish the session starting at this sequence number. |
19+
| Field | Type | Required | Description |
20+
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| `firstSeqNum` | *number* | :heavy_check_mark: | Sequence number for the first record on this stream.<br/>Typically this will be returned when the requested `start_seq_num` was smaller.<br/>It may also be returned during a session, if the stream gets concurrently trimmed. |

docs/models/components/message.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ let value: Message = {
2929

3030
## Fields
3131

32-
| Field | Type | Required | Description |
33-
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
34-
| `data` | *components.Output* | :heavy_check_mark: | Reply which can be a batch of records, or a sequence number if the request could not be satisfied. |
35-
| `event` | [components.Event](../../models/components/event.md) | :heavy_check_mark: | N/A |
32+
| Field | Type | Required | Description |
33+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34+
| `data` | *components.Output* | :heavy_check_mark: | Batch of records, or a sequence number if the read could not be satisfied.<br/>An empty batch or a sequence number output will be a terminal message in a session. |
35+
| `event` | [components.Event](../../models/components/event.md) | :heavy_check_mark: | N/A |

0 commit comments

Comments
 (0)