@knocklabs/agent-toolkit 0.1.1 → 0.1.3

package/dist/openai/tool-converter.js

@@ -0,0 +1,7 @@
+import {
+  knockToolToChatCompletionTool
+} from "../chunk-WB4XCCUS.js";
+export {
+  knockToolToChatCompletionTool
+};
+//# sourceMappingURL=tool-converter.js.map

package/dist/openai/tool-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types-B-9pppCQ.d.ts

@@ -0,0 +1,199 @@
+import { ZodObject } from 'zod';
+import { Knock } from '@knocklabs/node';
+import KnockMgmt from '@knocklabs/mgmt';
+
+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 const tools: {
+    channels: {
+        listChannels: KnockTool;
+    };
+    commits: {
+        listCommits: KnockTool;
+        commitAllChanges: KnockTool;
+        promoteAllCommits: KnockTool;
+    };
+    emailLayouts: {
+        listEmailLayouts: KnockTool;
+    };
+    environments: {
+        listEnvironments: KnockTool;
+    };
+    messages: {
+        getMessageContent: KnockTool;
+    };
+    messageTypes: {
+        listMessageTypes: KnockTool;
+        createOrUpdateMessageType: KnockTool;
+    };
+    objects: {
+        listObjects: KnockTool;
+        getObject: KnockTool;
+        createOrUpdateObject: KnockTool;
+        deleteObject: KnockTool;
+        subscribeUsersToObject: KnockTool;
+        unsubscribeUsersFromObject: KnockTool;
+    };
+    partials: {
+        listPartials: KnockTool;
+    };
+    tenants: {
+        getTenant: KnockTool;
+        setTenant: KnockTool;
+        deleteTenant: KnockTool;
+    };
+    users: {
+        getUser: KnockTool;
+        deleteUser: KnockTool;
+        createOrUpdateUser: KnockTool;
+        getUserPreferences: KnockTool;
+        setUserPreferences: KnockTool;
+        getUserMessages: KnockTool;
+    };
+    workflows: {
+        listWorkflows: KnockTool;
+        triggerWorkflow: KnockTool;
+        createEmailWorkflow: KnockTool;
+        createOneOffWorkflowSchedule: KnockTool;
+    };
+};
+declare const allTools: {
+    listWorkflows: KnockTool;
+    triggerWorkflow: KnockTool;
+    createEmailWorkflow: KnockTool;
+    createOneOffWorkflowSchedule: KnockTool;
+    getUser: KnockTool;
+    deleteUser: KnockTool;
+    createOrUpdateUser: KnockTool;
+    getUserPreferences: KnockTool;
+    setUserPreferences: KnockTool;
+    getUserMessages: KnockTool;
+    getTenant: KnockTool;
+    setTenant: KnockTool;
+    deleteTenant: KnockTool;
+    listPartials: KnockTool;
+    listObjects: KnockTool;
+    getObject: KnockTool;
+    createOrUpdateObject: KnockTool;
+    deleteObject: KnockTool;
+    subscribeUsersToObject: KnockTool;
+    unsubscribeUsersFromObject: KnockTool;
+    getMessageContent: KnockTool;
+    listMessageTypes: KnockTool;
+    createOrUpdateMessageType: KnockTool;
+    listEnvironments: KnockTool;
+    listEmailLayouts: KnockTool;
+    listCommits: KnockTool;
+    commitAllChanges: KnockTool;
+    promoteAllCommits: KnockTool;
+    listChannels: KnockTool;
+};
+declare const toolPermissions: {
+    channels: {
+        read: string[];
+    };
+    commits: {
+        read: string[];
+        manage: string[];
+    };
+    emailLayouts: {
+        read: string[];
+    };
+    environments: {
+        read: string[];
+    };
+    messages: {
+        read: string[];
+    };
+    messageTypes: {
+        read: string[];
+        manage: string[];
+    };
+    objects: {
+        read: string[];
+        manage: string[];
+    };
+    partials: {
+        read: string[];
+    };
+    tenants: {
+        read: string[];
+        manage: string[];
+    };
+    users: {
+        read: string[];
+        manage: string[];
+    };
+    workflows: {
+        read: string[];
+        manage: string[];
+        trigger: string[];
+    };
+};
+
+interface Config {
+    /**
+     * The token to use to authenticate with the service.
+     */
+    serviceToken: string;
+    /**
+     * When set calls will be made as this user.
+     */
+    userId?: string | undefined;
+    /**
+     * When set calls will be made in this tenant context.
+     */
+    tenantId?: string | undefined;
+    /**
+     * The environment to use as the basis for the API calls. When not defined, will default to
+     * the `development` environment.
+     */
+    environment?: string | undefined;
+}
+type TransformPermissions<T> = {
+    [K in keyof T]?: {
+        [P in keyof T[K]]?: boolean;
+    };
+};
+interface ToolkitConfig extends Config {
+    permissions: TransformPermissions<typeof toolPermissions>;
+}
+type ToolCategory = keyof typeof toolPermissions;
+
+export { type Config as C, type KnockClient as K, type ToolkitConfig as T, KnockTool as a, type ToolCategory as b, createKnockClient as c, type KnockToolDefinition as d, tools as e, allTools as f, type TransformPermissions as g, toolPermissions as t };

package/dist/types.d.ts

@@ -0,0 +1,4 @@
+export { C as Config, b as ToolCategory, T as ToolkitConfig, g as TransformPermissions } from './types-B-9pppCQ.js';
+import 'zod';
+import '@knocklabs/node';
+import '@knocklabs/mgmt';

package/dist/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/agent-toolkit",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A toolkit for working with Knock in Agent workflows.",
   "main": "src/index.js",
   "scripts": {
@@ -8,7 +8,7 @@
     "clean": "rimraf ./dist",
     "dev": "tsup --watch",
     "lint": "eslint src",
-    "release": "npm run build && npm run release:publish && npm changeset tag",
+    "release": "npm run build && npm run release:publish && changeset tag",
     "release:publish": "npm publish --access public --tolerate-republish"
   },
   "author": "Knock",
@@ -30,7 +30,7 @@
     }
   },
   "bin": {
-    "local-mcp": "./dist/modelcontextprotocol/local-server.js"
+    "local-mcp": "dist/modelcontextprotocol/local-server.js"
   },
   "files": [
     "dist"