@butlerbot/sdk 0.0.22 → 0.0.23

package/dist/link/protocol.d.ts

@@ -21,6 +21,7 @@ export type LinkToolDescriptor = {
         longDescription: string;
     };
     defaultEnabled?: boolean;
+    platforms?: string[];
     timeoutMs?: number;
 };
 export type LinkHookEventDeclaration = {

package/dist/link/tool.d.ts

@@ -64,6 +64,19 @@ export type ToolConfig<S extends ToolSchema | undefined> = {
     };
     /** Whether the tool is on before the user has touched it. */
     defaultEnabled?: boolean;
+    /**
+     * Where in Alfred the tool is reachable, as platform ids. Defaults to the user's chat.
+     *
+     * Say this when your client mirrors a whole platform. A Discord bot offering seventy tools does
+     * not want seventy entries in front of somebody having a conversation about their groceries — it
+     * wants them behind Alfred's Discord agent, which is one entry and already knows how to decide
+     * when Discord is relevant.
+     *
+     * Known values are Alfred's platform ids, e.g. `"platform.chat.user"` (the default) and
+     * `"platform.agent.discord"`. An unknown one is rejected at registration rather than ignored,
+     * because a tool reachable from nowhere is indistinguishable from a tool that is broken.
+     */
+    platforms?: string[];
     /** How long the server waits for a result before giving up. */
     timeoutMs?: number;
     /** Runs the tool. Return anything JSON-serialisable, or throw to fail the call. */

package/dist/link/tool.js

@@ -27,6 +27,7 @@ class Tool {
             inputSchema,
             ...(this.config.display ? { display: this.config.display } : {}),
             ...(this.config.defaultEnabled !== undefined ? { defaultEnabled: this.config.defaultEnabled } : {}),
+            ...(this.config.platforms ? { platforms: this.config.platforms } : {}),
             ...(this.config.timeoutMs !== undefined ? { timeoutMs: this.config.timeoutMs } : {}),
         };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@butlerbot/sdk",
-	"version": "0.0.22",
+	"version": "0.0.23",
 	"description": "The official ButlerBot SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/readme.md

@@ -156,6 +156,27 @@ Subscriptions are never persisted by the SDK. They arrive on connect, follow del
 connected, and are dropped on disconnect — so there is nothing to reconcile, and a restart is
 correct by construction.
 
+### Tools can belong to an agent instead of a chat
+
+By default a tool shows up where a user is talking to Alfred. If your client mirrors a whole
+platform, say so instead:
+
+```ts
+new Tool({
+    id: "discord_member_kick",
+    description: "Kick a member from a server.",
+    platforms: ["platform.agent.discord"],
+    run: async ({ args, meta }) => kick(meta.identities?.discord, args),
+});
+```
+
+Seventy tools in front of somebody asking about their groceries is not a feature. Behind Alfred's
+Discord agent they are one entry that already knows when Discord is relevant — and the agent keeps
+whatever tier and permission gating it carries, which tools bolted onto the chat would quietly skip.
+
+An unknown platform is rejected when you register, not ignored: a tool reachable from nowhere looks
+exactly like a tool that is broken.
+
 ### Tools belong to the user, not to a conversation
 
 Once a tool is registered, Alfred can call it anywhere that user talks to it — the web