release: 0.2

.github/workflows/release-doctor.yml

@@ -19,3 +19,4 @@ jobs:
           bash ./bin/check-release-environment
         env:
           NPM_TOKEN: ${{ secrets.BEEPER_DESKTOP_NPM_TOKEN || secrets.NPM_TOKEN }}
+

.gitignore

@@ -7,5 +7,6 @@ dist
 dist-deno
 /*.tgz
 .idea/
+.eslintcache
 dist-bundle
 *.mcpb

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.5"
+  ".": "0.1.6"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 14
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-8c712fe19f280b0b89ecc8a3ce61e9f6b165cee97ce33f66c66a7a5db339c755.yml
-openapi_spec_hash: 1ea71129cc1a1ccc3dc8a99566082311
-config_hash: 061b75b88f80bb43b4121e5e7c1255e2
+configured_endpoints: 15
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-a3fb0de6dd98f8a51d73e3fdf51de6143f2e8e764048246392624a56b4a3a481.yml
+openapi_spec_hash: 50e1001c340cb0bd3436b6329240769b
+config_hash: 2e31d02f28a11ef29eb747bcf559786a

CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## 0.1.6 (2025-10-07)
+
+Full Changelog: [v0.1.5...v0.1.6](https://github.com/beeper/desktop-api-js/compare/v0.1.5...v0.1.6)
+
+### Features
+
+* **api:** manual updates ([e12ab16](https://github.com/beeper/desktop-api-js/commit/e12ab16a4664ef6b770750225dc0e9ea53005b89))
+* **api:** manual updates ([914badc](https://github.com/beeper/desktop-api-js/commit/914badc5d98d1b3ab5b7d1b404c687110ef34913))
+* **api:** manual updates ([e657efe](https://github.com/beeper/desktop-api-js/commit/e657efe6bf48b6c76e09060ac00c8e0403213982))
+* **api:** manual updates ([0de85a3](https://github.com/beeper/desktop-api-js/commit/0de85a39f784415474e73187609e4ef4c5fe2cf1))
+* **api:** manual updates ([d7c35d2](https://github.com/beeper/desktop-api-js/commit/d7c35d27538be9752a6e15a4d17c4b5354b44b3f))
+* **api:** manual updates ([80f8804](https://github.com/beeper/desktop-api-js/commit/80f880478414edcba479e4717c5a1033a2545d3d))
+* **api:** manual updates ([e404d7e](https://github.com/beeper/desktop-api-js/commit/e404d7ebd08830f115f7468598cc275db637d508))
+* **api:** manual updates ([540c168](https://github.com/beeper/desktop-api-js/commit/540c168bfa982178e5ab743c9ef3986784438617))
+* **api:** manual updates ([3501ff9](https://github.com/beeper/desktop-api-js/commit/3501ff900847979fcf7b6e543a99364b74a979a5))
+* **api:** manual updates ([d1a5970](https://github.com/beeper/desktop-api-js/commit/d1a5970f917e9ddfe1060a4129feee7bb1be1414))
+* **api:** remove limit from list routes ([c145154](https://github.com/beeper/desktop-api-js/commit/c1451540df373793b5fd90e780faab8acf38a1dc))
+* **mcp:** add option for including docs tools ([a521cb8](https://github.com/beeper/desktop-api-js/commit/a521cb8f972778c0253b657b712da7681dd78853))
+* **mcp:** enable experimental docs search tool ([c349699](https://github.com/beeper/desktop-api-js/commit/c349699a05745356ce3d12dc693d643a85a52d5d))
+
+
+### Bug Fixes
+
+* **mcp:** fix cli argument parsing logic ([98c6489](https://github.com/beeper/desktop-api-js/commit/98c6489b8780dbe7d4ba377fb64364fb862fc7f7))
+* **mcp:** resolve a linting issue in server code ([2c84441](https://github.com/beeper/desktop-api-js/commit/2c8444166c9b4e6f67c9bf4827989aee65d672e8))
+
+
+### Performance Improvements
+
+* faster formatting ([a4321bf](https://github.com/beeper/desktop-api-js/commit/a4321bf9c91f3043414724486c130f3b0bd25606))
+
+
+### Chores
+
+* configure new SDK language ([f50310b](https://github.com/beeper/desktop-api-js/commit/f50310b4a7cc3e2286430530c8ffc867f77f7ef9))
+* configure new SDK language ([fee94ba](https://github.com/beeper/desktop-api-js/commit/fee94ba4b23ec91abc030ddbb872c08af43e2df8))
+* do not install brew dependencies in ./scripts/bootstrap by default ([cd62f83](https://github.com/beeper/desktop-api-js/commit/cd62f83fc5e6e93501df72cf49c0ee2838e02476))
+* fix changelog with actual entries ([45de3f5](https://github.com/beeper/desktop-api-js/commit/45de3f5a1d86486b9752e32cbd5283d6efe88434))
+* **internal:** codegen related update ([3598172](https://github.com/beeper/desktop-api-js/commit/3598172f0839f111c6000c9f29502d21afabee0c))
+* **internal:** codegen related update ([44137d6](https://github.com/beeper/desktop-api-js/commit/44137d644ffcd7407acc815a68d8df093e17f45d))
+* **internal:** fix incremental formatting in some cases ([697d742](https://github.com/beeper/desktop-api-js/commit/697d742608fead14c628f5d809b6a4beedff4656))
+* **internal:** ignore .eslintcache ([22d7f29](https://github.com/beeper/desktop-api-js/commit/22d7f29cd477bf4d22c68b51cd4b99bcf710efbd))
+* **internal:** remove .eslintcache ([f2a0dfb](https://github.com/beeper/desktop-api-js/commit/f2a0dfbd7930292f715ab530a6dedbf53e6ae8e3))
+* **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([ffaa6d6](https://github.com/beeper/desktop-api-js/commit/ffaa6d646236e88ecf997dc9a0b77733029a885b))
+* **internal:** use npm pack for build uploads ([31e0341](https://github.com/beeper/desktop-api-js/commit/31e0341efbad7c4b9abc13d145c477eb3676cc0b))
+* **jsdoc:** fix [@link](https://github.com/link) annotations to refer only to parts of the package‘s public interface ([8cf89a9](https://github.com/beeper/desktop-api-js/commit/8cf89a9e31969a45d24179342955b2a4e931ae6f))
+* **mcp:** allow pointing `docs_search` tool at other URLs ([6044c34](https://github.com/beeper/desktop-api-js/commit/6044c3467dd578e2fba46fa10f83ad3240222c3f))
+* update lockfile ([a9a736f](https://github.com/beeper/desktop-api-js/commit/a9a736fba58dde3c39bc2f5501be1ae30f380367))
+
 ## 0.1.5 (2025-09-19)
 
 Full Changelog: [v0.1.4...v0.1.5](https://github.com/beeper/desktop-api-js/compare/v0.1.4...v0.1.5)

api.md

@@ -1,3 +1,17 @@
+# BeeperDesktop
+
+Types:
+
+- <code><a href="./src/resources/top-level.ts">DownloadAssetResponse</a></code>
+- <code><a href="./src/resources/top-level.ts">OpenResponse</a></code>
+- <code><a href="./src/resources/top-level.ts">SearchResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/download-asset">client.<a href="./src/index.ts">downloadAsset</a>({ ...params }) -> DownloadAssetResponse</code>
+- <code title="post /v1/open">client.<a href="./src/index.ts">open</a>({ ...params }) -> OpenResponse</code>
+- <code title="get /v1/search">client.<a href="./src/index.ts">search</a>({ ...params }) -> SearchResponse</code>
+
 # Shared
 
 Types:
@@ -18,21 +32,7 @@ Types:
 
 Methods:
 
-- <code title="get /v0/get-accounts">client.accounts.<a href="./src/resources/accounts.ts">list</a>() -> AccountListResponse</code>
-
-# App
-
-Types:
-
-- <code><a href="./src/resources/app.ts">AppDownloadAssetResponse</a></code>
-- <code><a href="./src/resources/app.ts">AppOpenResponse</a></code>
-- <code><a href="./src/resources/app.ts">AppSearchResponse</a></code>
-
-Methods:
-
-- <code title="post /v0/download-asset">client.app.<a href="./src/resources/app.ts">downloadAsset</a>({ ...params }) -> AppDownloadAssetResponse</code>
-- <code title="post /v0/open-app">client.app.<a href="./src/resources/app.ts">open</a>({ ...params }) -> AppOpenResponse</code>
-- <code title="get /v0/search">client.app.<a href="./src/resources/app.ts">search</a>({ ...params }) -> AppSearchResponse</code>
+- <code title="get /v1/accounts">client.accounts.<a href="./src/resources/accounts.ts">list</a>() -> AccountListResponse</code>
 
 # Contacts
 
@@ -42,28 +42,30 @@ Types:
 
 Methods:
 
-- <code title="get /v0/search-users">client.contacts.<a href="./src/resources/contacts.ts">search</a>({ ...params }) -> ContactSearchResponse</code>
+- <code title="get /v1/contacts/search">client.contacts.<a href="./src/resources/contacts.ts">search</a>({ ...params }) -> ContactSearchResponse</code>
 
 # Chats
 
 Types:
 
 - <code><a href="./src/resources/chats/chats.ts">Chat</a></code>
 - <code><a href="./src/resources/chats/chats.ts">ChatCreateResponse</a></code>
+- <code><a href="./src/resources/chats/chats.ts">ChatListResponse</a></code>
 
 Methods:
 
-- <code title="post /v0/create-chat">client.chats.<a href="./src/resources/chats/chats.ts">create</a>({ ...params }) -> ChatCreateResponse</code>
-- <code title="get /v0/get-chat">client.chats.<a href="./src/resources/chats/chats.ts">retrieve</a>({ ...params }) -> Chat</code>
-- <code title="post /v0/archive-chat">client.chats.<a href="./src/resources/chats/chats.ts">archive</a>({ ...params }) -> BaseResponse</code>
-- <code title="get /v0/search-chats">client.chats.<a href="./src/resources/chats/chats.ts">search</a>({ ...params }) -> ChatsCursor</code>
+- <code title="post /v1/chats">client.chats.<a href="./src/resources/chats/chats.ts">create</a>({ ...params }) -> ChatCreateResponse</code>
+- <code title="get /v1/chats/{chatID}">client.chats.<a href="./src/resources/chats/chats.ts">retrieve</a>(chatID, { ...params }) -> Chat</code>
+- <code title="get /v1/chats">client.chats.<a href="./src/resources/chats/chats.ts">list</a>({ ...params }) -> ChatListResponsesCursorList</code>
+- <code title="post /v1/chats/{chatID}/archive">client.chats.<a href="./src/resources/chats/chats.ts">archive</a>(chatID, { ...params }) -> BaseResponse</code>
+- <code title="get /v1/chats/search">client.chats.<a href="./src/resources/chats/chats.ts">search</a>({ ...params }) -> ChatsCursorSearch</code>
 
 ## Reminders
 
 Methods:
 
-- <code title="post /v0/set-chat-reminder">client.chats.reminders.<a href="./src/resources/chats/reminders.ts">create</a>({ ...params }) -> BaseResponse</code>
-- <code title="post /v0/clear-chat-reminder">client.chats.reminders.<a href="./src/resources/chats/reminders.ts">delete</a>({ ...params }) -> BaseResponse</code>
+- <code title="post /v1/chats/{chatID}/reminders">client.chats.reminders.<a href="./src/resources/chats/reminders.ts">create</a>(chatID, { ...params }) -> BaseResponse</code>
+- <code title="delete /v1/chats/{chatID}/reminders">client.chats.reminders.<a href="./src/resources/chats/reminders.ts">delete</a>(chatID) -> BaseResponse</code>
 
 # Messages
 
@@ -73,16 +75,6 @@ Types:
 
 Methods:
 
-- <code title="get /v0/search-messages">client.messages.<a href="./src/resources/messages.ts">search</a>({ ...params }) -> MessagesCursor</code>
-- <code title="post /v0/send-message">client.messages.<a href="./src/resources/messages.ts">send</a>({ ...params }) -> MessageSendResponse</code>
-
-# Token
-
-Types:
-
-- <code><a href="./src/resources/token.ts">RevokeRequest</a></code>
-- <code><a href="./src/resources/token.ts">UserInfo</a></code>
-
-Methods:
-
-- <code title="get /oauth/userinfo">client.token.<a href="./src/resources/token.ts">info</a>() -> UserInfo</code>
+- <code title="get /v1/messages">client.messages.<a href="./src/resources/messages.ts">list</a>({ ...params }) -> MessagesCursorList</code>
+- <code title="get /v1/messages/search">client.messages.<a href="./src/resources/messages.ts">search</a>({ ...params }) -> MessagesCursorSearch</code>
+- <code title="post /v1/messages">client.messages.<a href="./src/resources/messages.ts">send</a>({ ...params }) -> MessageSendResponse</code>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beeper/desktop-api",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "The official TypeScript library for the Beeper Desktop API",
   "author": "Beeper Desktop <[email protected]>",
   "types": "dist/index.d.ts",

packages/mcp-server/README.md

@@ -180,7 +180,7 @@ http://localhost:3000?client=cursor&capability=tool-name-length%3D40
 import { server, endpoints, init } from "@beeper/desktop-mcp/server";
 
 // import a specific tool
-import getAccounts from "@beeper/desktop-mcp/tools/accounts/get-accounts";
+import openInApp from "@beeper/desktop-mcp/tools/top-level/open-in-app";
 
 // initialize the server and all endpoints
 init({ server, endpoints });
@@ -205,22 +205,22 @@ const myCustomEndpoint = {
 };
 
 // initialize the server with your custom endpoints
-init({ server: myServer, endpoints: [getAccounts, myCustomEndpoint] });
+init({ server: myServer, endpoints: [openInApp, myCustomEndpoint] });
 ```
 
 ## Available Tools
 
 The following tools are available in this MCP server.
 
-### Resource `accounts`:
-
-- `get_accounts` (`read`) tags: [accounts]: List connected accounts on this device. Use to pick account context.
-
-### Resource `app`:
+### Resource `$client`:
 
 - `open_in_app` (`write`) tags: [app]: Open Beeper Desktop and optionally navigate to a specific chat, message, or pre-fill draft text and attachment.
 - `search` (`read`) tags: [app]: Search for chats, participant name matches in groups, and the first page of messages in one call. Use this when the user asks for a specific chat, group, or person.
 
+### Resource `accounts`:
+
+- `get_accounts` (`read`) tags: [accounts]: List connected accounts on this device.
+
 ### Resource `chats`:
 
 - `get_chat` (`read`) tags: [chats]: Get chat details: metadata, participants (limited), last activity.

packages/mcp-server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beeper/desktop-mcp",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "The official MCP Server for the Beeper Desktop API",
   "author": "Beeper Desktop <[email protected]>",
   "types": "dist/index.d.ts",

packages/mcp-server/src/docs-search-tool.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Metadata, asTextContentResult } from './tools/types';
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+
+export const metadata: Metadata = {
+  resource: 'all',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+};
+
+export const tool: Tool = {
+  name: 'search_docs',
+  description:
+    'Search for documentation for how to use the client to interact with the API.\nThe tool will return an array of Markdown-formatted documentation pages.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      query: {
+        type: 'string',
+        description: 'The query to search for.',
+      },
+      language: {
+        type: 'string',
+        description: 'The language for the SDK to search for.',
+        enum: ['http', 'python', 'go', 'typescript', 'terraform', 'ruby', 'java', 'kotlin'],
+      },
+    },
+    required: ['query', 'language'],
+  },
+  annotations: {
+    readOnlyHint: true,
+  },
+};
+
+const docsSearchURL =
+  process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/beeper-desktop-api/docs/search';
+
+export const handler = async (_: unknown, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  const query = new URLSearchParams(body).toString();
+  const result = await fetch(`${docsSearchURL}?${query}`);
+  return asTextContentResult(await result.json());
+};
+
+export default { metadata, tool, handler };

packages/mcp-server/src/options.ts

@@ -17,6 +17,7 @@ export type McpOptions = {
   includeDynamicTools?: boolean | undefined;
   includeAllTools?: boolean | undefined;
   includeCodeTools?: boolean | undefined;
+  includeDocsTools?: boolean | undefined;
   filters?: Filter[] | undefined;
   capabilities?: Partial<ClientCapabilities> | undefined;
 };
@@ -55,13 +56,13 @@ export function parseCLIOptions(): CLIOptions {
     .option('tools', {
       type: 'string',
       array: true,
-      choices: ['dynamic', 'all', 'code'],
+      choices: ['dynamic', 'all', 'code', 'docs'],
       description: 'Use dynamic tools or all tools',
     })
     .option('no-tools', {
       type: 'string',
       array: true,
-      choices: ['dynamic', 'all', 'code'],
+      choices: ['dynamic', 'all', 'code', 'docs'],
       description: 'Do not use any dynamic or all tools',
     })
     .option('tool', {
@@ -245,13 +246,15 @@ export function parseCLIOptions(): CLIOptions {
     }
   }
 
-  const shouldIncludeToolType = (toolType: 'dynamic' | 'all' | 'code') =>
-    explicitTools ? argv.tools?.includes(toolType) && !argv.noTools?.includes(toolType) : undefined;
+  const shouldIncludeToolType = (toolType: 'dynamic' | 'all' | 'code' | 'docs') =>
+    argv.noTools?.includes(toolType) ? false
+    : argv.tools?.includes(toolType) ? true
+    : undefined;
 
-  const explicitTools = Boolean(argv.tools || argv.noTools);
   const includeDynamicTools = shouldIncludeToolType('dynamic');
   const includeAllTools = shouldIncludeToolType('all');
   const includeCodeTools = shouldIncludeToolType('code');
+  const includeDocsTools = shouldIncludeToolType('docs');
 
   const transport = argv.transport as 'stdio' | 'http';
 
@@ -261,6 +264,7 @@ export function parseCLIOptions(): CLIOptions {
     includeDynamicTools,
     includeAllTools,
     includeCodeTools,
+    includeDocsTools,
     filters,
     capabilities: clientCapabilities,
     list: argv.list || false,
@@ -280,8 +284,8 @@ const coerceArray = <T extends z.ZodTypeAny>(zodType: T) =>
   );
 
 const QueryOptions = z.object({
-  tools: coerceArray(z.enum(['dynamic', 'all'])).describe('Use dynamic tools or all tools'),
-  no_tools: coerceArray(z.enum(['dynamic', 'all'])).describe('Do not use dynamic tools or all tools'),
+  tools: coerceArray(z.enum(['dynamic', 'all', 'docs'])).describe('Use dynamic tools or all tools'),
+  no_tools: coerceArray(z.enum(['dynamic', 'all', 'docs'])).describe('Do not use dynamic tools or all tools'),
   tool: coerceArray(z.string()).describe('Include tools matching the specified names'),
   resource: coerceArray(z.string()).describe('Include tools matching the specified resources'),
   operation: coerceArray(z.enum(['read', 'write'])).describe(
@@ -376,11 +380,17 @@ export function parseQueryOptions(defaultOptions: McpOptions, query: unknown): M
     : queryOptions.tools?.includes('all') ? true
     : defaultOptions.includeAllTools;
 
+  let docsTools: boolean | undefined =
+    queryOptions.no_tools && queryOptions.no_tools?.includes('docs') ? false
+    : queryOptions.tools?.includes('docs') ? true
+    : defaultOptions.includeDocsTools;
+
   return {
     client: queryOptions.client ?? defaultOptions.client,
     includeDynamicTools: dynamicTools,
     includeAllTools: allTools,
     includeCodeTools: undefined,
+    includeDocsTools: docsTools,
     filters,
     capabilities: clientCapabilities,
   };