release: 0.1.1 (#2)

* codegen metadata

* codegen metadata

* chore: configure new SDK language

* release: 0.1.1

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '22'
 
       - name: Bootstrap
         run: ./scripts/bootstrap
@@ -46,7 +46,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '22'
 
       - name: Bootstrap
         run: ./scripts/bootstrap
@@ -68,6 +68,15 @@ jobs:
           AUTH: ${{ steps.github-oidc.outputs.github_token }}
           SHA: ${{ github.sha }}
         run: ./scripts/utils/upload-artifact.sh
+
+      - name: Upload MCP Server tarball
+        if: github.repository == 'stainless-sdks/schools-typescript'
+        env:
+          URL: https://pkg.stainless.com/s?subpackage=mcp-server
+          AUTH: ${{ steps.github-oidc.outputs.github_token }}
+          SHA: ${{ github.sha }}
+          BASE_PATH: packages/mcp-server
+        run: ./scripts/utils/upload-artifact.sh
   test:
     timeout-minutes: 10
     name: test
@@ -79,10 +88,13 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '22'
 
       - name: Bootstrap
         run: ./scripts/bootstrap
 
+      - name: Build
+        run: ./scripts/build
+
       - name: Run tests
         run: ./scripts/test

.gitignore

@@ -8,4 +8,5 @@ dist-deno
 /*.tgz
 .idea/
 .eslintcache
-
+dist-bundle
+*.mcpb

.prettierignore

@@ -4,4 +4,4 @@ CHANGELOG.md
 /deno
 
 # don't format tsc output, will break source maps
-/dist
+dist

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0"
+  ".": "0.1.1"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 11
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/yufugumi%2Fschools-8b2bd24c42e8cbbe595f5ff86d5b647b19c5db3fe7b0b88e89ac62579e87e0b2.yml
 openapi_spec_hash: 3585f4f3c71183b9e2275426853a1cd2
-config_hash: 2c255d0cb2ebe374b8702a252dfe01a9
+config_hash: 922170ad50ac6f28eaec9e268efa4a66

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.1 (2025-11-04)
+
+Full Changelog: [v0.1.0...v0.1.1](https://github.com/et0and/schools-sdk-typescript/compare/v0.1.0...v0.1.1)
+
+### Chores
+
+* configure new SDK language ([7b7101d](https://github.com/et0and/schools-sdk-typescript/commit/7b7101d3856f3ce0e338ce2e1af17248350feeb5))
+
 ## 0.1.0 (2025-10-17)
 
 Full Changelog: [v0.0.1...v0.1.0](https://github.com/et0and/schools-sdk-typescript/compare/v0.0.1...v0.1.0)

eslint.config.mjs

@@ -34,7 +34,7 @@ export default tseslint.config(
     },
   },
   {
-    files: ['tests/**', 'examples/**'],
+    files: ['tests/**', 'examples/**', 'packages/**'],
     rules: {
       'no-restricted-imports': 'off',
     },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "schools-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The official TypeScript library for the Schools API",
   "author": "Schools <info@yufugumi.com>",
   "types": "dist/index.d.ts",

packages/mcp-server/README.md

@@ -0,0 +1,245 @@
+# Schools TypeScript MCP Server
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Installation
+
+### Building
+
+Because it's not published yet, clone the repo and build it:
+
+```sh
+git clone git@github.com:et0and/schools-sdk-typescript.git
+cd schools-sdk-typescript
+./scripts/bootstrap
+./scripts/build
+```
+
+### Running
+
+```sh
+# set env vars as needed
+export SCHOOLS_API_KEY="My API Key"
+export SCHOOLS_ENVIRONMENT="production"
+node ./packages/mcp-server/dist/index.js
+```
+
+> [!NOTE]
+> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npx -y schools-sdk-mcp`
+
+### Via MCP Client
+
+[Build the project](#building) as mentioned above.
+
+There is a partial list of existing clients at [modelcontextprotocol.io](https://modelcontextprotocol.io/clients). If you already
+have a client, consult their documentation to install the MCP server.
+
+For clients with a configuration JSON, it might look something like this:
+
+```json
+{
+  "mcpServers": {
+    "schools_sdk_api": {
+      "command": "node",
+      "args": ["/path/to/local/schools-sdk-typescript/packages/mcp-server", "--client=claude", "--tools=all"],
+      "env": {
+        "SCHOOLS_API_KEY": "My API Key",
+        "SCHOOLS_ENVIRONMENT": "production"
+      }
+    }
+  }
+}
+```
+
+## Exposing endpoints to your MCP Client
+
+There are two ways to expose endpoints as tools in the MCP server:
+
+1. Exposing one tool per endpoint, and filtering as necessary
+2. Exposing a set of tools to dynamically discover and invoke endpoints from the API
+
+### Filtering endpoints and tools
+
+You can run the package on the command line to discover and filter the set of tools that are exposed by the
+MCP Server. This can be helpful for large APIs where including all endpoints at once is too much for your AI's
+context window.
+
+You can filter by multiple aspects:
+
+- `--tool` includes a specific tool by name
+- `--resource` includes all tools under a specific resource, and can have wildcards, e.g. `my.resource*`
+- `--operation` includes just read (get/list) or just write operations
+
+### Dynamic tools
+
+If you specify `--tools=dynamic` to the MCP server, instead of exposing one tool per endpoint in the API, it will
+expose the following tools:
+
+1. `list_api_endpoints` - Discovers available endpoints, with optional filtering by search query
+2. `get_api_endpoint_schema` - Gets detailed schema information for a specific endpoint
+3. `invoke_api_endpoint` - Executes any endpoint with the appropriate parameters
+
+This allows you to have the full set of API endpoints available to your MCP Client, while not requiring that all
+of their schemas be loaded into context at once. Instead, the LLM will automatically use these tools together to
+search for, look up, and invoke endpoints dynamically. However, due to the indirect nature of the schemas, it
+can struggle to provide the correct properties a bit more than when tools are imported explicitly. Therefore,
+you can opt-in to explicit tools, the dynamic tools, or both.
+
+See more information with `--help`.
+
+All of these command-line options can be repeated, combined together, and have corresponding exclusion versions (e.g. `--no-tool`).
+
+Use `--list` to see the list of available tools, or see below.
+
+### Specifying the MCP Client
+
+Different clients have varying abilities to handle arbitrary tools and schemas.
+
+You can specify the client you are using with the `--client` argument, and the MCP server will automatically
+serve tools and schemas that are more compatible with that client.
+
+- `--client=<type>`: Set all capabilities based on a known MCP client
+
+  - Valid values: `openai-agents`, `claude`, `claude-code`, `cursor`
+  - Example: `--client=cursor`
+
+Additionally, if you have a client not on the above list, or the client has gotten better
+over time, you can manually enable or disable certain capabilities:
+
+- `--capability=<name>`: Specify individual client capabilities
+  - Available capabilities:
+    - `top-level-unions`: Enable support for top-level unions in tool schemas
+    - `valid-json`: Enable JSON string parsing for arguments
+    - `refs`: Enable support for $ref pointers in schemas
+    - `unions`: Enable support for union types (anyOf) in schemas
+    - `formats`: Enable support for format validations in schemas (e.g. date-time, email)
+    - `tool-name-length=N`: Set maximum tool name length to N characters
+  - Example: `--capability=top-level-unions --capability=tool-name-length=40`
+  - Example: `--capability=top-level-unions,tool-name-length=40`
+
+### Examples
+
+1. Filter for read operations on cards:
+
+```bash
+--resource=cards --operation=read
+```
+
+2. Exclude specific tools while including others:
+
+```bash
+--resource=cards --no-tool=create_cards
+```
+
+3. Configure for Cursor client with custom max tool name length:
+
+```bash
+--client=cursor --capability=tool-name-length=40
+```
+
+4. Complex filtering with multiple criteria:
+
+```bash
+--resource=cards,accounts --operation=read --tag=kyc --no-tool=create_cards
+```
+
+## Running remotely
+
+Launching the client with `--transport=http` launches the server as a remote server using Streamable HTTP transport. The `--port` setting can choose the port it will run on, and the `--socket` setting allows it to run on a Unix socket.
+
+Authorization can be provided via the `Authorization` header using the Bearer scheme.
+
+Additionally, authorization can be provided via the following headers:
+| Header | Equivalent client option | Security scheme |
+| ------------------- | ------------------------ | --------------- |
+| `x-schools-api-key` | `apiKey` | bearerAuth |
+
+A configuration JSON for this server might look like this, assuming the server is hosted at `http://localhost:3000`:
+
+```json
+{
+  "mcpServers": {
+    "schools_sdk_api": {
+      "url": "http://localhost:3000",
+      "headers": {
+        "Authorization": "Bearer <auth value>"
+      }
+    }
+  }
+}
+```
+
+The command-line arguments for filtering tools and specifying clients can also be used as query parameters in the URL.
+For example, to exclude specific tools while including others, use the URL:
+
+```
+http://localhost:3000?resource=cards&resource=accounts&no_tool=create_cards
+```
+
+Or, to configure for the Cursor client, with a custom max tool name length, use the URL:
+
+```
+http://localhost:3000?client=cursor&capability=tool-name-length%3D40
+```
+
+## Importing the tools and server individually
+
+```js
+// Import the server, generated endpoints, or the init function
+import { server, endpoints, init } from "schools-sdk-mcp/server";
+
+// import a specific tool
+import checkHealth from "schools-sdk-mcp/tools/health/check-health";
+
+// initialize the server and all endpoints
+init({ server, endpoints });
+
+// manually start server
+const transport = new StdioServerTransport();
+await server.connect(transport);
+
+// or initialize your own server with specific tools
+const myServer = new McpServer(...);
+
+// define your own endpoint
+const myCustomEndpoint = {
+  tool: {
+    name: 'my_custom_tool',
+    description: 'My custom tool',
+    inputSchema: zodToJsonSchema(z.object({ a_property: z.string() })),
+  },
+  handler: async (client: client, args: any) => {
+    return { myResponse: 'Hello world!' };
+  })
+};
+
+// initialize the server with your custom endpoints
+init({ server: myServer, endpoints: [checkHealth, myCustomEndpoint] });
+```
+
+## Available Tools
+
+The following tools are available in this MCP server.
+
+### Resource `health`:
+
+- `check_health` (`read`): API health check
+
+### Resource `root`:
+
+- `retrieve_root` (`read`): API root information
+
+### Resource `schools`:
+
+- `retrieve_schools` (`read`): Get school by School ID
+- `list_schools` (`read`): Get all schools with filtering
+- `by_authority_schools` (`read`): Get schools by authority
+- `by_city_schools` (`read`): Get schools by city
+- `by_status_schools` (`read`): Get schools by status
+- `by_suburb_schools` (`read`): Get schools by suburb
+- `search_schools` (`read`): Full-text search schools by name
+
+### Resource `sync`:
+
+- `get_status_sync` (`read`): Get sync status
+- `trigger_sync` (`write`): Trigger manual data sync