feat(api): update via SDK Studio

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/beeper-desktop-api-typescript'
+        env:
+          URL: https://pkg.stainless.com/s?subpackage=mcp-server
+          AUTH: ${{ steps.github-oidc.outputs.github_token }}
+          SHA: ${{ github.sha }}
+          BUILD_PATH: packages/mcp-server/dist
+        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

.github/workflows/publish-npm.yml

@@ -4,6 +4,10 @@
 name: Publish NPM
 on:
   workflow_dispatch:
+    inputs:
+      path:
+        description: The path to run the release in, e.g. '.' or 'packages/mcp-server'
+        required: true
 
   release:
     types: [published]
@@ -27,6 +31,11 @@ jobs:
 
       - name: Publish to NPM
         run: |
-          bash ./bin/publish-npm
+          if [ -n "${{ github.event.inputs.path }}" ]; then
+            PATHS_RELEASED='[\"${{ github.event.inputs.path }}\"]'
+          else
+            PATHS_RELEASED='[\".\", \"packages/mcp-server\"]'
+          fi
+          yarn tsn scripts/publish-packages.ts "{ \"paths_released\": \"$PATHS_RELEASED\" }"
         env:
           NPM_TOKEN: ${{ secrets.BEEPER-DESKTOP_NPM_TOKEN || secrets.NPM_TOKEN }}

.prettierignore

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

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 13
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-10508b7bd52381c216ed2584b7b0894f70fcc97fbd7f86792e78f72d108157c5.yml
 openapi_spec_hash: d5f07fd2a363877f4c72da1187b8aaf1
-config_hash: a8d561a8c61cf63e15937fa7cbbd2c46
+config_hash: ee676f5f5342918d6bf4fde9e77d1c5c

eslint.config.mjs

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

packages/mcp-server/README.md

@@ -0,0 +1,265 @@
+# Beeper Desktop TypeScript MCP Server
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Installation
+
+### Direct invocation
+
+You can run the MCP Server directly via `npx`:
+
+```sh
+export BEEPER_ACCESS_TOKEN="My Access Token"
+npx -y beeper/desktop-api-typescript-mcp@latest
+```
+
+### Via MCP Client
+
+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": {
+    "desktop_api_typescript_api": {
+      "command": "npx",
+      "args": ["-y", "beeper/desktop-api-typescript-mcp", "--client=claude", "--tools=all"],
+      "env": {
+        "BEEPER_ACCESS_TOKEN": "My Access Token"
+      }
+    }
+  }
+}
+```
+
+## 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-beeper-access-token` | `accessToken` | bearerAuth |
+
+A configuration JSON for this server might look like this, assuming the server is hosted at `http://localhost:3000`:
+
+```json
+{
+  "mcpServers": {
+    "desktop_api_typescript_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 "beeper/desktop-api-typescript-mcp/server";
+
+// import a specific tool
+import listAccounts from "beeper/desktop-api-typescript-mcp/tools/accounts/list-accounts";
+
+// 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: [listAccounts, myCustomEndpoint] });
+```
+
+## Available Tools
+
+The following tools are available in this MCP server.
+
+### Resource `accounts`:
+
+- `list_accounts` (`read`): List connected Beeper accounts available on this device.
+  - When to use: select account context before account-scoped operations.
+  - Scope: only accounts currently Connected on this device are included.
+    Returns: connected accounts.
+
+### Resource `app`:
+
+- `focus_app` (`write`): Bring Beeper Desktop to the foreground on this device. Optionally focuses a specific chat if chatID is provided.
+  - When to use: open Beeper, or jump to a specific chat.
+  - Constraints: requires Beeper Desktop running locally; no-op in headless environments.
+  - Idempotent: safe to call repeatedly. Returns an error if chatID is not found.
+    Returns: success.
+
+### Resource `messages`:
+
+- `draft_messages` (`write`): Draft a message in a specific chat. This will be placed in the message input field without sending
+- `search_messages` (`read`): Search messages across chats using Beeper's message index.
+  - When to use: find messages by text and/or filters (chatIDs, accountIDs, chatType, media type filters, sender, date ranges).
+  - CRITICAL: Query is LITERAL WORD MATCHING, NOT semantic search! Only finds messages containing these EXACT words.
+    • ✅ RIGHT: query="dinner" or query="sick" or query="error" (single words users type)
+    • ❌ WRONG: query="dinner plans tonight" or query="health issues" (phrases/concepts)
+    • The query matches ALL words provided (in any order). Example: query="flight booking" finds messages with both "flight" AND "booking".
+  - Media filters: Use onlyWithMedia for any media, or specific filters like onlyWithVideo, onlyWithImage, onlyWithLink, onlyWithFile for specific types.
+  - Pagination: use 'oldestCursor' + direction='before' for older; 'newestCursor' + direction='after' for newer.
+  - Performance: provide chatIDs/accountIDs when known. Omitted 'query' returns results based on filters only. Partial matches enabled; 'excludeLowPriority' defaults to true.
+  - Workflow tip: To search messages in specific conversations: 1) Use find-chats to get chatIDs, 2) Use search-messages with those chatIDs.
+  - IMPORTANT: Chat names vary widely. ASK the user for clarification:
+    • "Which chat do you mean by family?" (could be "The Smiths", "Mom Dad Kids", etc.)
+    • "What's the name of your work chat?" (could be "Team", company name, project name)
+    • "Who are the participants?" (use participantQuery in find-chats)
+    Returns: matching messages and referenced chats.
+- `send_messages` (`write`): Send a text message to a specific chat. Supports replying to existing messages. Returns the sent message ID and a deeplink to the chat
+
+### Resource `chats`:
+
+- `retrieve_chats` (`read`): Retrieve chat details: metadata, participants (limited), and latest message.
+  - When to use: fetch a complete view of a chat beyond what search returns.
+  - Constraints: not available for iMessage chats ('imsg##'). Participants limited by 'maxParticipantCount' (default 20, max 500).
+    Returns: chat details.Agents: ALWAYS use linkToChat to make clickable links in your response
+- `archive_chats` (`write`): Archive or unarchive a chat. Set archived=true to move to archive, archived=false to move back to inbox
+- `find_chats` (`read`): Search and filter conversations across all messaging accounts.
+  - When to use: browse chats by inbox (primary/low-priority/archive), type, unread status, or search terms.
+  - Pagination: use cursor + direction for pagination.
+  - Performance: provide accountIDs when known for faster filtering.
+    Returns: matching chats with pagination.
+    Agents: ALWAYS use linkToChat to make clickable links in your response
+- `get_link_chats` (`write`): Generate a deep link to a specific chat or message. This link can be used to open the chat directly in the Beeper app.
+
+### Resource `reminders`:
+
+- `clear_reminders` (`write`): Clear an existing reminder from a chat
+- `set_reminders` (`write`): Set a reminder for a chat at a specific time
+
+### Resource `oauth`:
+
+- `get_user_info_oauth` (`read`): Returns information about the authenticated user/token
+- `revoke_token_oauth` (`write`): Revoke an access token or refresh token (RFC 7009)

packages/mcp-server/build

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+set -exuo pipefail
+
+rm -rf dist; mkdir dist
+
+# Copy src to dist/src and build from dist/src into dist, so that
+# the source map for index.js.map will refer to ./src/index.ts etc
+cp -rp src README.md dist
+
+for file in LICENSE; do
+  if [ -e "../../${file}" ]; then cp "../../${file}" dist; fi
+done
+
+for file in CHANGELOG.md; do
+  if [ -e "${file}" ]; then cp "${file}" dist; fi
+done
+
+# this converts the export map paths for the dist directory
+# and does a few other minor things
+PKG_JSON_PATH=../../packages/mcp-server/package.json node ../../scripts/utils/make-dist-package-json.cjs > dist/package.json
+
+# updates the `desktop-api-typescript` dependency to point to NPM
+node scripts/postprocess-dist-package-json.cjs
+
+# build to .js/.mjs/.d.ts files
+./node_modules/.bin/tsc-multi
+
+cp tsconfig.dist-src.json dist/src/tsconfig.json
+
+chmod +x dist/index.js
+
+DIST_PATH=./dist PKG_IMPORT_PATH=beeper/desktop-api-typescript-mcp/ node ../../scripts/utils/postprocess-files.cjs