@dexto/tools-builtins 1.6.0

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/dist/builtin-tools-factory.cjs

@@ -0,0 +1,95 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var builtin_tools_factory_exports = {};
+__export(builtin_tools_factory_exports, {
+  BUILTIN_TOOL_NAMES: () => BUILTIN_TOOL_NAMES,
+  BuiltinToolsConfigSchema: () => BuiltinToolsConfigSchema,
+  builtinToolsFactory: () => builtinToolsFactory
+});
+module.exports = __toCommonJS(builtin_tools_factory_exports);
+var import_zod = require("zod");
+var import_ask_user_tool = require("./implementations/ask-user-tool.js");
+var import_delegate_to_url_tool = require("./implementations/delegate-to-url-tool.js");
+var import_get_resource_tool = require("./implementations/get-resource-tool.js");
+var import_invoke_skill_tool = require("./implementations/invoke-skill-tool.js");
+var import_list_resources_tool = require("./implementations/list-resources-tool.js");
+var import_http_request_tool = require("./implementations/http-request-tool.js");
+var import_sleep_tool = require("./implementations/sleep-tool.js");
+var import_exa_web_search_tool = require("./implementations/exa-web-search-tool.js");
+var import_exa_code_search_tool = require("./implementations/exa-code-search-tool.js");
+const BUILTIN_TOOL_NAMES = [
+  "ask_user",
+  "delegate_to_url",
+  "list_resources",
+  "get_resource",
+  "invoke_skill",
+  "http_request",
+  "sleep",
+  "web_search",
+  "code_search"
+];
+const BuiltinToolNameSchema = import_zod.z.enum(BUILTIN_TOOL_NAMES);
+const BuiltinToolsConfigSchema = import_zod.z.object({
+  type: import_zod.z.literal("builtin-tools"),
+  enabledTools: import_zod.z.array(BuiltinToolNameSchema).optional()
+}).strict();
+function createToolByName(name) {
+  switch (name) {
+    case "ask_user":
+      return (0, import_ask_user_tool.createAskUserTool)();
+    case "delegate_to_url":
+      return (0, import_delegate_to_url_tool.createDelegateToUrlTool)();
+    case "list_resources":
+      return (0, import_list_resources_tool.createListResourcesTool)();
+    case "get_resource":
+      return (0, import_get_resource_tool.createGetResourceTool)();
+    case "invoke_skill":
+      return (0, import_invoke_skill_tool.createInvokeSkillTool)();
+    case "http_request":
+      return (0, import_http_request_tool.createHttpRequestTool)();
+    case "sleep":
+      return (0, import_sleep_tool.createSleepTool)();
+    case "web_search":
+      return (0, import_exa_web_search_tool.createWebSearchTool)();
+    case "code_search":
+      return (0, import_exa_code_search_tool.createCodeSearchTool)();
+    default: {
+      const exhaustive = name;
+      throw new Error(`Unknown builtin tool: ${exhaustive}`);
+    }
+  }
+}
+const builtinToolsFactory = {
+  configSchema: BuiltinToolsConfigSchema,
+  metadata: {
+    displayName: "Built-in Tools",
+    description: "Core built-in tools shipped with Dexto",
+    category: "core"
+  },
+  create: (config) => {
+    const enabled = config.enabledTools ?? [...BUILTIN_TOOL_NAMES];
+    return enabled.map(createToolByName);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BUILTIN_TOOL_NAMES,
+  BuiltinToolsConfigSchema,
+  builtinToolsFactory
+});

package/dist/builtin-tools-factory.d.cts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { ToolFactory } from '@dexto/agent-config';
+
+declare const BUILTIN_TOOL_NAMES: readonly ["ask_user", "delegate_to_url", "list_resources", "get_resource", "invoke_skill", "http_request", "sleep", "web_search", "code_search"];
+type BuiltinToolName = (typeof BUILTIN_TOOL_NAMES)[number];
+declare const BuiltinToolsConfigSchema: z.ZodObject<{
+    type: z.ZodLiteral<"builtin-tools">;
+    enabledTools: z.ZodOptional<z.ZodArray<z.ZodEnum<["ask_user", "delegate_to_url", "list_resources", "get_resource", "invoke_skill", "http_request", "sleep", "web_search", "code_search"]>, "many">>;
+}, "strict", z.ZodTypeAny, {
+    type: "builtin-tools";
+    enabledTools?: ("ask_user" | "delegate_to_url" | "list_resources" | "get_resource" | "invoke_skill" | "http_request" | "sleep" | "web_search" | "code_search")[] | undefined;
+}, {
+    type: "builtin-tools";
+    enabledTools?: ("ask_user" | "delegate_to_url" | "list_resources" | "get_resource" | "invoke_skill" | "http_request" | "sleep" | "web_search" | "code_search")[] | undefined;
+}>;
+type BuiltinToolsConfig = z.output<typeof BuiltinToolsConfigSchema>;
+declare const builtinToolsFactory: ToolFactory<BuiltinToolsConfig>;
+
+export { BUILTIN_TOOL_NAMES, type BuiltinToolName, type BuiltinToolsConfig, BuiltinToolsConfigSchema, builtinToolsFactory };

package/dist/builtin-tools-factory.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+import type { ToolFactory } from '@dexto/agent-config';
+export declare const BUILTIN_TOOL_NAMES: readonly ["ask_user", "delegate_to_url", "list_resources", "get_resource", "invoke_skill", "http_request", "sleep", "web_search", "code_search"];
+export type BuiltinToolName = (typeof BUILTIN_TOOL_NAMES)[number];
+export declare const BuiltinToolsConfigSchema: z.ZodObject<{
+    type: z.ZodLiteral<"builtin-tools">;
+    enabledTools: z.ZodOptional<z.ZodArray<z.ZodEnum<["ask_user", "delegate_to_url", "list_resources", "get_resource", "invoke_skill", "http_request", "sleep", "web_search", "code_search"]>, "many">>;
+}, "strict", z.ZodTypeAny, {
+    type: "builtin-tools";
+    enabledTools?: ("ask_user" | "delegate_to_url" | "get_resource" | "invoke_skill" | "list_resources" | "http_request" | "sleep" | "web_search" | "code_search")[] | undefined;
+}, {
+    type: "builtin-tools";
+    enabledTools?: ("ask_user" | "delegate_to_url" | "get_resource" | "invoke_skill" | "list_resources" | "http_request" | "sleep" | "web_search" | "code_search")[] | undefined;
+}>;
+export type BuiltinToolsConfig = z.output<typeof BuiltinToolsConfigSchema>;
+export declare const builtinToolsFactory: ToolFactory<BuiltinToolsConfig>;
+//# sourceMappingURL=builtin-tools-factory.d.ts.map

package/dist/builtin-tools-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builtin-tools-factory.d.ts","sourceRoot":"","sources":["../src/builtin-tools-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAYvD,eAAO,MAAM,kBAAkB,kJAUrB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAIlE,eAAO,MAAM,wBAAwB;;;;;;;;;EAKxB,CAAC;AAEd,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAC;AA6B3E,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAAC,kBAAkB,CAW/D,CAAC"}

package/dist/builtin-tools-factory.js

@@ -0,0 +1,69 @@
+import { z } from "zod";
+import { createAskUserTool } from "./implementations/ask-user-tool.js";
+import { createDelegateToUrlTool } from "./implementations/delegate-to-url-tool.js";
+import { createGetResourceTool } from "./implementations/get-resource-tool.js";
+import { createInvokeSkillTool } from "./implementations/invoke-skill-tool.js";
+import { createListResourcesTool } from "./implementations/list-resources-tool.js";
+import { createHttpRequestTool } from "./implementations/http-request-tool.js";
+import { createSleepTool } from "./implementations/sleep-tool.js";
+import { createWebSearchTool } from "./implementations/exa-web-search-tool.js";
+import { createCodeSearchTool } from "./implementations/exa-code-search-tool.js";
+const BUILTIN_TOOL_NAMES = [
+  "ask_user",
+  "delegate_to_url",
+  "list_resources",
+  "get_resource",
+  "invoke_skill",
+  "http_request",
+  "sleep",
+  "web_search",
+  "code_search"
+];
+const BuiltinToolNameSchema = z.enum(BUILTIN_TOOL_NAMES);
+const BuiltinToolsConfigSchema = z.object({
+  type: z.literal("builtin-tools"),
+  enabledTools: z.array(BuiltinToolNameSchema).optional()
+}).strict();
+function createToolByName(name) {
+  switch (name) {
+    case "ask_user":
+      return createAskUserTool();
+    case "delegate_to_url":
+      return createDelegateToUrlTool();
+    case "list_resources":
+      return createListResourcesTool();
+    case "get_resource":
+      return createGetResourceTool();
+    case "invoke_skill":
+      return createInvokeSkillTool();
+    case "http_request":
+      return createHttpRequestTool();
+    case "sleep":
+      return createSleepTool();
+    case "web_search":
+      return createWebSearchTool();
+    case "code_search":
+      return createCodeSearchTool();
+    default: {
+      const exhaustive = name;
+      throw new Error(`Unknown builtin tool: ${exhaustive}`);
+    }
+  }
+}
+const builtinToolsFactory = {
+  configSchema: BuiltinToolsConfigSchema,
+  metadata: {
+    displayName: "Built-in Tools",
+    description: "Core built-in tools shipped with Dexto",
+    category: "core"
+  },
+  create: (config) => {
+    const enabled = config.enabledTools ?? [...BUILTIN_TOOL_NAMES];
+    return enabled.map(createToolByName);
+  }
+};
+export {
+  BUILTIN_TOOL_NAMES,
+  BuiltinToolsConfigSchema,
+  builtinToolsFactory
+};

package/dist/builtin-tools-factory.test.cjs

@@ -0,0 +1,26 @@
+"use strict";
+var import_vitest = require("vitest");
+var import_builtin_tools_factory = require("./builtin-tools-factory.js");
+(0, import_vitest.describe)("builtinToolsFactory", () => {
+  (0, import_vitest.it)("creates all builtins when enabledTools is omitted", () => {
+    const tools = import_builtin_tools_factory.builtinToolsFactory.create({ type: "builtin-tools" });
+    (0, import_vitest.expect)(tools.map((t) => t.id)).toEqual([
+      "ask_user",
+      "delegate_to_url",
+      "list_resources",
+      "get_resource",
+      "invoke_skill",
+      "http_request",
+      "sleep",
+      "web_search",
+      "code_search"
+    ]);
+  });
+  (0, import_vitest.it)("creates only the selected builtins when enabledTools is provided", () => {
+    const tools = import_builtin_tools_factory.builtinToolsFactory.create({
+      type: "builtin-tools",
+      enabledTools: ["ask_user", "invoke_skill"]
+    });
+    (0, import_vitest.expect)(tools.map((t) => t.id)).toEqual(["ask_user", "invoke_skill"]);
+  });
+});

package/dist/builtin-tools-factory.test.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/builtin-tools-factory.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=builtin-tools-factory.test.d.ts.map

package/dist/builtin-tools-factory.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builtin-tools-factory.test.d.ts","sourceRoot":"","sources":["../src/builtin-tools-factory.test.ts"],"names":[],"mappings":""}

package/dist/builtin-tools-factory.test.js

@@ -0,0 +1,25 @@
+import { describe, expect, it } from "vitest";
+import { builtinToolsFactory } from "./builtin-tools-factory.js";
+describe("builtinToolsFactory", () => {
+  it("creates all builtins when enabledTools is omitted", () => {
+    const tools = builtinToolsFactory.create({ type: "builtin-tools" });
+    expect(tools.map((t) => t.id)).toEqual([
+      "ask_user",
+      "delegate_to_url",
+      "list_resources",
+      "get_resource",
+      "invoke_skill",
+      "http_request",
+      "sleep",
+      "web_search",
+      "code_search"
+    ]);
+  });
+  it("creates only the selected builtins when enabledTools is provided", () => {
+    const tools = builtinToolsFactory.create({
+      type: "builtin-tools",
+      enabledTools: ["ask_user", "invoke_skill"]
+    });
+    expect(tools.map((t) => t.id)).toEqual(["ask_user", "invoke_skill"]);
+  });
+});

package/dist/implementations/ask-user-tool.cjs

@@ -0,0 +1,65 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var ask_user_tool_exports = {};
+__export(ask_user_tool_exports, {
+  createAskUserTool: () => createAskUserTool
+});
+module.exports = __toCommonJS(ask_user_tool_exports);
+var import_zod = require("zod");
+var import_core = require("@dexto/core");
+const AskUserInputSchema = import_zod.z.object({
+  question: import_zod.z.string().describe("The question or prompt to display to the user"),
+  schema: import_zod.z.object({
+    type: import_zod.z.literal("object"),
+    properties: import_zod.z.record(import_zod.z.unknown()),
+    required: import_zod.z.array(import_zod.z.string()).optional()
+  }).passthrough().describe(
+    'JSON Schema defining form fields. Use descriptive property names as labels (e.g., "favorite_team", "World Cup winner country") - NOT generic names like "q1". Use "enum" for dropdowns, "boolean" for yes/no, "number" for numeric inputs, "string" for text. Include "required" array for mandatory fields.'
+  )
+}).strict();
+function createAskUserTool() {
+  return (0, import_core.defineTool)({
+    id: "ask_user",
+    displayName: "Ask",
+    description: 'Collect structured input from the user through a form interface. ONLY use this tool when you need: 1) Multiple fields at once (e.g., name + email + preferences), 2) Pre-defined options/choices (use enum for dropdowns like ["small","medium","large"]), 3) Specific data types with validation (boolean for yes/no, number for quantities). DO NOT use for simple conversational questions - just ask those naturally in your response. This tool is for form-like data collection, not chat. Examples: collecting user profile info, configuration settings, or selecting from preset options.',
+    inputSchema: AskUserInputSchema,
+    async execute(input, context) {
+      const { question, schema } = input;
+      const approvalManager = context.services?.approval;
+      if (!approvalManager) {
+        throw import_core.ToolError.configInvalid(
+          "ask_user requires ToolExecutionContext.services.approval"
+        );
+      }
+      const elicitationRequest = {
+        schema,
+        prompt: question,
+        serverName: "Dexto Agent"
+      };
+      if (context.sessionId !== void 0) {
+        elicitationRequest.sessionId = context.sessionId;
+      }
+      return approvalManager.getElicitationData(elicitationRequest);
+    }
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createAskUserTool
+});

package/dist/implementations/ask-user-tool.d.cts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+import { Tool } from '@dexto/core';
+
+declare const AskUserInputSchema: z.ZodObject<{
+    question: z.ZodString;
+    schema: z.ZodObject<{
+        type: z.ZodLiteral<"object">;
+        properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        type: z.ZodLiteral<"object">;
+        properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        type: z.ZodLiteral<"object">;
+        properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strict", z.ZodTypeAny, {
+    question: string;
+    schema: {
+        type: "object";
+        properties: Record<string, unknown>;
+        required?: string[] | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+}, {
+    question: string;
+    schema: {
+        type: "object";
+        properties: Record<string, unknown>;
+        required?: string[] | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+}>;
+/**
+ * Create the `ask_user` tool.
+ *
+ * Uses the approval/elicitation channel to collect structured user input via a JSON Schema form.
+ * Requires `ToolExecutionContext.services.approval`.
+ */
+declare function createAskUserTool(): Tool<typeof AskUserInputSchema>;
+
+export { createAskUserTool };

package/dist/implementations/ask-user-tool.d.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+import type { Tool } from '@dexto/core';
+declare const AskUserInputSchema: z.ZodObject<{
+    question: z.ZodString;
+    schema: z.ZodObject<{
+        type: z.ZodLiteral<"object">;
+        properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        type: z.ZodLiteral<"object">;
+        properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        type: z.ZodLiteral<"object">;
+        properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strict", z.ZodTypeAny, {
+    question: string;
+    schema: {
+        type: "object";
+        properties: Record<string, unknown>;
+        required?: string[] | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+}, {
+    question: string;
+    schema: {
+        type: "object";
+        properties: Record<string, unknown>;
+        required?: string[] | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+}>;
+/**
+ * Create the `ask_user` tool.
+ *
+ * Uses the approval/elicitation channel to collect structured user input via a JSON Schema form.
+ * Requires `ToolExecutionContext.services.approval`.
+ */
+export declare function createAskUserTool(): Tool<typeof AskUserInputSchema>;
+export {};
+//# sourceMappingURL=ask-user-tool.d.ts.map

package/dist/implementations/ask-user-tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ask-user-tool.d.ts","sourceRoot":"","sources":["../../src/implementations/ask-user-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,IAAI,EAAwB,MAAM,aAAa,CAAC;AAE9D,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcX,CAAC;AAEd;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAmCnE"}

package/dist/implementations/ask-user-tool.js

@@ -0,0 +1,41 @@
+import { z } from "zod";
+import { ToolError, defineTool } from "@dexto/core";
+const AskUserInputSchema = z.object({
+  question: z.string().describe("The question or prompt to display to the user"),
+  schema: z.object({
+    type: z.literal("object"),
+    properties: z.record(z.unknown()),
+    required: z.array(z.string()).optional()
+  }).passthrough().describe(
+    'JSON Schema defining form fields. Use descriptive property names as labels (e.g., "favorite_team", "World Cup winner country") - NOT generic names like "q1". Use "enum" for dropdowns, "boolean" for yes/no, "number" for numeric inputs, "string" for text. Include "required" array for mandatory fields.'
+  )
+}).strict();
+function createAskUserTool() {
+  return defineTool({
+    id: "ask_user",
+    displayName: "Ask",
+    description: 'Collect structured input from the user through a form interface. ONLY use this tool when you need: 1) Multiple fields at once (e.g., name + email + preferences), 2) Pre-defined options/choices (use enum for dropdowns like ["small","medium","large"]), 3) Specific data types with validation (boolean for yes/no, number for quantities). DO NOT use for simple conversational questions - just ask those naturally in your response. This tool is for form-like data collection, not chat. Examples: collecting user profile info, configuration settings, or selecting from preset options.',
+    inputSchema: AskUserInputSchema,
+    async execute(input, context) {
+      const { question, schema } = input;
+      const approvalManager = context.services?.approval;
+      if (!approvalManager) {
+        throw ToolError.configInvalid(
+          "ask_user requires ToolExecutionContext.services.approval"
+        );
+      }
+      const elicitationRequest = {
+        schema,
+        prompt: question,
+        serverName: "Dexto Agent"
+      };
+      if (context.sessionId !== void 0) {
+        elicitationRequest.sessionId = context.sessionId;
+      }
+      return approvalManager.getElicitationData(elicitationRequest);
+    }
+  });
+}
+export {
+  createAskUserTool
+};