@knocklabs/agent-toolkit 0.1.2 → 0.1.4

package/dist/chunk-ZV2SOIO7.js

@@ -0,0 +1,91 @@
+import {
+  toolPermissions,
+  tools
+} from "./chunk-RPKDXX4O.js";
+
+// src/lib/utils.ts
+function filterTools(tools2, pattern) {
+  if (!pattern) {
+    throw new Error("No pattern provided");
+  }
+  if (pattern === "*") {
+    return Object.values(tools2).flatMap((category2) => Object.values(category2));
+  }
+  const [category, tool] = pattern.split(".");
+  if (category === "*" && tool === "*") {
+    return Object.values(tools2).flatMap((category2) => Object.values(category2));
+  }
+  if (category && !tools2[category]) {
+    throw new Error(`Tool category ${category} not found`);
+  }
+  if (category && tool === "*") {
+    return Object.values(tools2[category]);
+  }
+  if (category && tool && !tools2[category][tool]) {
+    throw new Error(`Tool ${pattern} not found`);
+  }
+  return [tools2[category][tool]];
+}
+function getToolsWithPermissions(category, categoryPermissions) {
+  const toolsInCategory = tools[category];
+  const toolPermissionsInCategory = toolPermissions[category];
+  return Object.entries(categoryPermissions).reduce(
+    (acc, [permissionType, hasPermission]) => {
+      if (hasPermission) {
+        return acc.concat(
+          toolPermissionsInCategory[permissionType].map(
+            (toolName) => toolsInCategory[toolName]
+          )
+        );
+      }
+      return acc;
+    },
+    []
+  );
+}
+function getToolsByPermissionsInCategories(config) {
+  return Object.keys(config.permissions).reduce(
+    (acc, category) => {
+      const categoryKey = category;
+      const categoryPermissions = config.permissions[categoryKey];
+      if (tools[categoryKey] && categoryPermissions) {
+        const tools2 = getToolsWithPermissions(categoryKey, categoryPermissions);
+        return { ...acc, [categoryKey]: tools2 };
+      }
+      return acc;
+    },
+    {}
+  );
+}
+
+// src/lib/knock-client.ts
+import { Knock } from "@knocklabs/node";
+import KnockMgmt from "@knocklabs/mgmt";
+var serviceTokensToApiClients = {};
+var createKnockClient = (config) => {
+  const client = new KnockMgmt({
+    serviceToken: config.serviceToken
+  });
+  return Object.assign(client, {
+    publicApi: async (_environment) => {
+      const environment = _environment ?? config.environment ?? "development";
+      if (serviceTokensToApiClients?.[config.serviceToken]?.[environment]) {
+        return serviceTokensToApiClients[config.serviceToken][environment];
+      }
+      const { api_key } = await client.apiKeys.exchange({ environment });
+      const knock = new Knock(api_key);
+      if (!serviceTokensToApiClients[config.serviceToken]) {
+        serviceTokensToApiClients[config.serviceToken] = {};
+      }
+      serviceTokensToApiClients[config.serviceToken][environment] = knock;
+      return knock;
+    }
+  });
+};
+
+export {
+  filterTools,
+  getToolsByPermissionsInCategories,
+  createKnockClient
+};
+//# sourceMappingURL=chunk-ZV2SOIO7.js.map

package/dist/chunk-ZV2SOIO7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/utils.ts","../src/lib/knock-client.ts"],"sourcesContent":["import { KnockTool } from \"./knock-tool.js\";\nimport { toolPermissions, tools } from \"../lib/tools/index.js\";\nimport { ToolkitConfig } from \"../types.js\";\nimport { ToolCategory } from \"../types.js\";\n\n/**\n * Given a list of tools, and some config may describe the tools that should be provided to the LLM,\n * returns a filtered list of tools that match the config.\n *\n * Options:\n * `*` - All tools\n * `users.*` - All tools that start with `users.`\n * `users.getUser` - A specific tool\n *\n */\nexport function filterTools(\n  tools: Record<string, Record<string, KnockTool>>,\n  pattern: string | undefined\n): KnockTool[] {\n  if (!pattern) {\n    throw new Error(\"No pattern provided\");\n  }\n\n  // If the pattern is `*`, return all tools\n  if (pattern === \"*\") {\n    return Object.values(tools).flatMap((category) => Object.values(category));\n  }\n\n  const [category, tool] = pattern.split(\".\");\n\n  // If the pattern is `*.*`, return all tools\n  if (category === \"*\" && tool === \"*\") {\n    return Object.values(tools).flatMap((category) => Object.values(category));\n  }\n\n  if (category && !tools[category]) {\n    throw new Error(`Tool category ${category} not found`);\n  }\n\n  // If the pattern is `users.*`, return all tools that start with `users.`\n  if (category && tool === \"*\") {\n    return Object.values(tools[category]);\n  }\n\n  // If the pattern is `users.getUser`, return the `getUser` tool\n  if (category && tool && !tools[category][tool]) {\n    throw new Error(`Tool ${pattern} not found`);\n  }\n\n  return [tools[category][tool]];\n}\n\n/**\n * Given a category and a list of permissions, return a list of tools that the user has permission to use.\n *\n * @param category - The category to get tools for\n * @param categoryPermissions - The permissions to use\n * @returns A list of tools that the user has permission to use\n */\nexport function getToolsWithPermissions(\n  category: keyof typeof toolPermissions,\n  categoryPermissions: Record<string, boolean | undefined>\n) {\n  // Return all of the tools for the category that have permission\n  const toolsInCategory = tools[category] as Record<string, KnockTool>;\n  const toolPermissionsInCategory = toolPermissions[category] as Record<\n    string,\n    string[]\n  >;\n\n  // Look over each permission type, like `read: true`\n  // If it's `true`, then find all of the tools that have that permission\n  return Object.entries(categoryPermissions).reduce(\n    (acc: KnockTool[], [permissionType, hasPermission]) => {\n      if (hasPermission) {\n        return acc.concat(\n          toolPermissionsInCategory[permissionType].map(\n            (toolName) => toolsInCategory[toolName]\n          )\n        );\n      }\n      return acc;\n    },\n    []\n  );\n}\n\n/**\n * Given a config, return a list of tools for each category that the user has permission to use.\n *\n * @param config - The config to use\n * @returns A list of tools for each category that the user has permission to use\n */\nexport function getToolsByPermissionsInCategories(\n  config: ToolkitConfig\n): Record<ToolCategory, KnockTool[]> {\n  return Object.keys(config.permissions).reduce(\n    (acc, category) => {\n      const categoryKey = category as ToolCategory;\n      const categoryPermissions = config.permissions[categoryKey];\n\n      if (tools[categoryKey] && categoryPermissions) {\n        const tools = getToolsWithPermissions(categoryKey, categoryPermissions);\n\n        return { ...acc, [categoryKey]: tools };\n      }\n\n      return acc;\n    },\n    {} as Record<ToolCategory, KnockTool[]>\n  );\n}\n","import { Knock } from \"@knocklabs/node\";\nimport KnockMgmt from \"@knocklabs/mgmt\";\nimport { Config } from \"../types.js\";\n\nconst serviceTokensToApiClients: Record<string, Record<string, Knock>> = {};\n\ntype KnockClient = ReturnType<typeof createKnockClient>;\n\nconst createKnockClient = (config: Config) => {\n  const client = new KnockMgmt({\n    serviceToken: config.serviceToken,\n  });\n\n  return Object.assign(client, {\n    publicApi: async (_environment?: string): Promise<Knock> => {\n      const environment = _environment ?? config.environment ?? \"development\";\n\n      // If the client already exists for this service token and environment, return it\n      if (serviceTokensToApiClients?.[config.serviceToken]?.[environment]) {\n        return serviceTokensToApiClients[config.serviceToken][environment];\n      }\n\n      // Otherwise, fetch a public API key for this service token and environment\n      const { api_key } = await client.apiKeys.exchange({ environment });\n\n      // Create a new Knock client with the public API key\n      const knock = new Knock(api_key);\n\n      // Store the client in the cache\n      if (!serviceTokensToApiClients[config.serviceToken]) {\n        serviceTokensToApiClients[config.serviceToken] = {};\n      }\n\n      serviceTokensToApiClients[config.serviceToken][environment] = knock;\n\n      return knock;\n    },\n  });\n};\n\nexport { createKnockClient, type KnockClient };\n"],"mappings":";;;;;;AAeO,SAAS,YACdA,QACA,SACa;AACb,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,MAAM,qBAAqB;AAAA,EACvC;AAGA,MAAI,YAAY,KAAK;AACnB,WAAO,OAAO,OAAOA,MAAK,EAAE,QAAQ,CAACC,cAAa,OAAO,OAAOA,SAAQ,CAAC;AAAA,EAC3E;AAEA,QAAM,CAAC,UAAU,IAAI,IAAI,QAAQ,MAAM,GAAG;AAG1C,MAAI,aAAa,OAAO,SAAS,KAAK;AACpC,WAAO,OAAO,OAAOD,MAAK,EAAE,QAAQ,CAACC,cAAa,OAAO,OAAOA,SAAQ,CAAC;AAAA,EAC3E;AAEA,MAAI,YAAY,CAACD,OAAM,QAAQ,GAAG;AAChC,UAAM,IAAI,MAAM,iBAAiB,QAAQ,YAAY;AAAA,EACvD;AAGA,MAAI,YAAY,SAAS,KAAK;AAC5B,WAAO,OAAO,OAAOA,OAAM,QAAQ,CAAC;AAAA,EACtC;AAGA,MAAI,YAAY,QAAQ,CAACA,OAAM,QAAQ,EAAE,IAAI,GAAG;AAC9C,UAAM,IAAI,MAAM,QAAQ,OAAO,YAAY;AAAA,EAC7C;AAEA,SAAO,CAACA,OAAM,QAAQ,EAAE,IAAI,CAAC;AAC/B;AASO,SAAS,wBACd,UACA,qBACA;AAEA,QAAM,kBAAkB,MAAM,QAAQ;AACtC,QAAM,4BAA4B,gBAAgB,QAAQ;AAO1D,SAAO,OAAO,QAAQ,mBAAmB,EAAE;AAAA,IACzC,CAAC,KAAkB,CAAC,gBAAgB,aAAa,MAAM;AACrD,UAAI,eAAe;AACjB,eAAO,IAAI;AAAA,UACT,0BAA0B,cAAc,EAAE;AAAA,YACxC,CAAC,aAAa,gBAAgB,QAAQ;AAAA,UACxC;AAAA,QACF;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AACF;AAQO,SAAS,kCACd,QACmC;AACnC,SAAO,OAAO,KAAK,OAAO,WAAW,EAAE;AAAA,IACrC,CAAC,KAAK,aAAa;AACjB,YAAM,cAAc;AACpB,YAAM,sBAAsB,OAAO,YAAY,WAAW;AAE1D,UAAI,MAAM,WAAW,KAAK,qBAAqB;AAC7C,cAAMA,SAAQ,wBAAwB,aAAa,mBAAmB;AAEtE,eAAO,EAAE,GAAG,KAAK,CAAC,WAAW,GAAGA,OAAM;AAAA,MACxC;AAEA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AACF;;;AC/GA,SAAS,aAAa;AACtB,OAAO,eAAe;AAGtB,IAAM,4BAAmE,CAAC;AAI1E,IAAM,oBAAoB,CAAC,WAAmB;AAC5C,QAAM,SAAS,IAAI,UAAU;AAAA,IAC3B,cAAc,OAAO;AAAA,EACvB,CAAC;AAED,SAAO,OAAO,OAAO,QAAQ;AAAA,IAC3B,WAAW,OAAO,iBAA0C;AAC1D,YAAM,cAAc,gBAAgB,OAAO,eAAe;AAG1D,UAAI,4BAA4B,OAAO,YAAY,IAAI,WAAW,GAAG;AACnE,eAAO,0BAA0B,OAAO,YAAY,EAAE,WAAW;AAAA,MACnE;AAGA,YAAM,EAAE,QAAQ,IAAI,MAAM,OAAO,QAAQ,SAAS,EAAE,YAAY,CAAC;AAGjE,YAAM,QAAQ,IAAI,MAAM,OAAO;AAG/B,UAAI,CAAC,0BAA0B,OAAO,YAAY,GAAG;AACnD,kCAA0B,OAAO,YAAY,IAAI,CAAC;AAAA,MACpD;AAEA,gCAA0B,OAAO,YAAY,EAAE,WAAW,IAAI;AAE9D,aAAO;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":["tools","category"]}

package/dist/modelcontextprotocol/index.d.ts

@@ -1,9 +1,50 @@
-import { a as KnockTool, K as KnockClient, C as Config } from '../types-B-9pppCQ.js';
-import { KnockMcpServer } from './adapter.js';
-import 'zod';
-import '@knocklabs/node';
-import '@knocklabs/mgmt';
-import '@modelcontextprotocol/sdk/server/mcp.js';
+import { ZodObject } from 'zod';
+import { C as Config } from '../types-DyB12-Gk.js';
+import { Knock } from '@knocklabs/node';
+import KnockMgmt from '@knocklabs/mgmt';
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+
+type KnockClient = ReturnType<typeof createKnockClient>;
+declare const createKnockClient: (config: Config) => KnockMgmt & {
+    publicApi: (_environment?: string) => Promise<Knock>;
+};
+
+interface KnockToolDefinition {
+    /**
+     * The method name of the tool. This is a machine-readable string.
+     */
+    method: string;
+    /**
+     * The name of the tool. This can be used to reference the tool in the code.
+     * A descriptive LLM-readable string.
+     */
+    name: string;
+    /**
+     * A descriptive prompt explaining the tool's purpose, including examples where useful.
+     */
+    description: string;
+    /**
+     * A descriptive prompt explaining the tool's purpose, usage and input parameters.
+     * Ths is intended to be used by the underlying LLM.
+     */
+    fullDescription: string;
+    /**
+     * The Zod schema for the input parameters of the tool
+     */
+    parameters?: ZodObject<any>;
+    /**
+     * The actual implementation of the tool.
+     */
+    execute: (knockClient: KnockClient, config: Config) => (input: any) => Promise<unknown>;
+}
+interface KnockTool extends Omit<KnockToolDefinition, "execute"> {
+    bindExecute: (knockClient: KnockClient, config: Config) => (input: any) => Promise<unknown>;
+}
+declare const KnockTool: (args: Omit<KnockToolDefinition, "fullDescription">) => KnockTool;
+
+declare class KnockMcpServer extends McpServer {
+    constructor(knockClient: KnockClient, config: Config, tools: KnockTool[]);
+}
 
 type CreateKnockMcpServerParams = {
     /**