@aigne/agent-library 1.24.0 → 1.74.0-beta

package/README.md

@@ -2,28 +2,28 @@
 
 <p align="center">
   <picture>
-    <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo-dark.svg" media="(prefers-color-scheme: dark)">
-    <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo.svg" media="(prefers-color-scheme: light)">
-    <img src="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo.svg" alt="AIGNE Logo" width="400" />
+    <source srcset="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/logo-dark.svg" media="(prefers-color-scheme: dark)">
+    <source srcset="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/logo.svg" media="(prefers-color-scheme: light)">
+    <img src="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/logo.svg" alt="AIGNE Logo" width="400" />
   </picture>
 </p>
 
-[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
-[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
-[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![GitHub star chart](https://img.shields.io/github/stars/ArcBlock/aigne-framework?style=flat-square)](https://star-history.com/#ArcBlock/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/ArcBlock/aigne-framework?style=flat-square)](https://github.com/ArcBlock/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/ArcBlock/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/ArcBlock/aigne-framework)
 [![NPM Version](https://img.shields.io/npm/v/@aigne/agent-library)](https://www.npmjs.com/package/@aigne/agent-library)
-[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/agent-library)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/agent-library)](https://github.com/ArcBlock/aigne-framework/blob/main/LICENSE)
 
-Collection of agent libraries for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing pre-built agent implementations.
+Collection of agent libraries for [AIGNE Framework](https://github.com/ArcBlock/aigne-framework), providing pre-built agent implementations.
 
 ## Introduction
 
-`@aigne/agent-library` is a collection of agent libraries for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing pre-built agent implementations for developers. The library is built on top of [@aigne/core](https://github.com/AIGNE-io/aigne-framework/tree/main/packages/core), extending the core functionality to simplify complex workflow orchestration.
+`@aigne/agent-library` is a collection of agent libraries for [AIGNE Framework](https://github.com/ArcBlock/aigne-framework), providing pre-built agent implementations for developers. The library is built on top of [@aigne/core](https://github.com/ArcBlock/aigne-framework/tree/main/packages/core), extending the core functionality to simplify complex workflow orchestration.
 
 <picture>
-  <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/assets/aigne-libs-dark.png" media="(prefers-color-scheme: dark)">
-  <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/assets/aigne-libs.png" media="(prefers-color-scheme: light)">
-  <img src="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/aigne-libs.png" alt="AIGNE Arch" />
+  <source srcset="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/assets/aigne-libs-dark.png" media="(prefers-color-scheme: dark)">
+  <source srcset="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/assets/aigne-libs.png" media="(prefers-color-scheme: light)">
+  <img src="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/aigne-libs.png" alt="AIGNE Arch" />
 </picture>
 
 ## Features

package/dist/_virtual/rolldown_runtime.cjs

@@ -0,0 +1,29 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+exports.__toESM = __toESM;

package/dist/agent-skill-manager/index.cjs

@@ -0,0 +1,30 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_prompt = require('./prompt.cjs');
+let _aigne_core = require("@aigne/core");
+
+//#region src/agent-skill-manager/index.ts
+var AgentSkillManagerAgent = class extends _aigne_core.AIAgent {
+	static async load(options) {
+		const valid = await _aigne_core.AIAgent.schema(options).parseAsync(options.parsed);
+		return _aigne_core.AIAgent.load({
+			...options,
+			parsed: {
+				...options.parsed,
+				instructions: valid.instructions || [{
+					role: "system",
+					content: require_prompt.AgentSkillManagerSystemPrompt,
+					path: options.filepath
+				}]
+			}
+		});
+	}
+	constructor(options) {
+		super({
+			...options,
+			instructions: options.instructions || require_prompt.AgentSkillManagerSystemPrompt
+		});
+	}
+};
+
+//#endregion
+module.exports = AgentSkillManagerAgent;

package/dist/agent-skill-manager/index.d.cts

@@ -0,0 +1,14 @@
+import { AIAgent, AIAgentOptions, Agent, Message } from "@aigne/core";
+
+//#region src/agent-skill-manager/index.d.ts
+interface AgentSkillManagerOptions<I extends Message = Message, O extends Message = Message> extends AIAgentOptions<I, O> {}
+declare class AgentSkillManagerAgent<I extends Message = Message, O extends Message = Message> extends AIAgent<I, O> {
+  static load<I extends Message = any, O extends Message = any>(options: {
+    filepath: string;
+    parsed: object;
+  }): Promise<Agent<I, O>>;
+  constructor(options: AgentSkillManagerOptions<I, O>);
+}
+//#endregion
+export { AgentSkillManagerOptions, AgentSkillManagerAgent as default };
+//# sourceMappingURL=index.d.cts.map

package/dist/agent-skill-manager/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/agent-skill-manager/index.ts"],"mappings":";;;UASiB,wBAAA,WAAmC,OAAA,GAAU,OAAA,YAAmB,OAAA,GAAU,OAAA,UACjF,cAAA,CAAe,CAAA,EAAG,CAAA;AAAA,cAEP,sBAAA,WACT,OAAA,GAAU,OAAA,YACV,OAAA,GAAU,OAAA,UACZ,OAAA,CAAQ,CAAA,EAAG,CAAA;EAAA,OAAA,IAAA,WACkB,OAAA,kBAAyB,OAAA,OAAA,CAAA,OAAA;IAAA,QAAA;IAAA,MAAA;EAAA,IAG1D,OAAA,CAAQ,KAAA,CAAM,CAAA,EAAG,CAAA;EAAA,YAAA,OAAA,EAcA,wBAAA,CAAyB,CAAA,EAAG,CAAA;AAAA"}

package/dist/agent-skill-manager/index.d.mts

@@ -0,0 +1,14 @@
+import { AIAgent, AIAgentOptions, Agent, Message } from "@aigne/core";
+
+//#region src/agent-skill-manager/index.d.ts
+interface AgentSkillManagerOptions<I extends Message = Message, O extends Message = Message> extends AIAgentOptions<I, O> {}
+declare class AgentSkillManagerAgent<I extends Message = Message, O extends Message = Message> extends AIAgent<I, O> {
+  static load<I extends Message = any, O extends Message = any>(options: {
+    filepath: string;
+    parsed: object;
+  }): Promise<Agent<I, O>>;
+  constructor(options: AgentSkillManagerOptions<I, O>);
+}
+//#endregion
+export { AgentSkillManagerOptions, AgentSkillManagerAgent as default };
+//# sourceMappingURL=index.d.mts.map

package/dist/agent-skill-manager/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/agent-skill-manager/index.ts"],"mappings":";;;UASiB,wBAAA,WAAmC,OAAA,GAAU,OAAA,YAAmB,OAAA,GAAU,OAAA,UACjF,cAAA,CAAe,CAAA,EAAG,CAAA;AAAA,cAEP,sBAAA,WACT,OAAA,GAAU,OAAA,YACV,OAAA,GAAU,OAAA,UACZ,OAAA,CAAQ,CAAA,EAAG,CAAA;EAAA,OAAA,IAAA,WACkB,OAAA,kBAAyB,OAAA,OAAA,CAAA,OAAA;IAAA,QAAA;IAAA,MAAA;EAAA,IAG1D,OAAA,CAAQ,KAAA,CAAM,CAAA,EAAG,CAAA;EAAA,YAAA,OAAA,EAcA,wBAAA,CAAyB,CAAA,EAAG,CAAA;AAAA"}

package/dist/agent-skill-manager/index.mjs

@@ -0,0 +1,30 @@
+import { AgentSkillManagerSystemPrompt } from "./prompt.mjs";
+import { AIAgent } from "@aigne/core";
+
+//#region src/agent-skill-manager/index.ts
+var AgentSkillManagerAgent = class extends AIAgent {
+	static async load(options) {
+		const valid = await AIAgent.schema(options).parseAsync(options.parsed);
+		return AIAgent.load({
+			...options,
+			parsed: {
+				...options.parsed,
+				instructions: valid.instructions || [{
+					role: "system",
+					content: AgentSkillManagerSystemPrompt,
+					path: options.filepath
+				}]
+			}
+		});
+	}
+	constructor(options) {
+		super({
+			...options,
+			instructions: options.instructions || AgentSkillManagerSystemPrompt
+		});
+	}
+};
+
+//#endregion
+export { AgentSkillManagerAgent as default };
+//# sourceMappingURL=index.mjs.map

package/dist/agent-skill-manager/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/agent-skill-manager/index.ts"],"sourcesContent":["import {\n  type Agent,\n  AIAgent,\n  type AIAgentLoadSchema,\n  type AIAgentOptions,\n  type Message,\n} from \"@aigne/core\";\nimport { AgentSkillManagerSystemPrompt } from \"./prompt.js\";\n\nexport interface AgentSkillManagerOptions<I extends Message = Message, O extends Message = Message>\n  extends AIAgentOptions<I, O> {}\n\nexport default class AgentSkillManagerAgent<\n  I extends Message = Message,\n  O extends Message = Message,\n> extends AIAgent<I, O> {\n  static override async load<I extends Message = any, O extends Message = any>(options: {\n    filepath: string;\n    parsed: object;\n  }): Promise<Agent<I, O>> {\n    const schema = AIAgent.schema<AIAgentLoadSchema>(options);\n    const valid = await schema.parseAsync(options.parsed);\n    return AIAgent.load({\n      ...options,\n      parsed: {\n        ...options.parsed,\n        instructions: valid.instructions || [\n          { role: \"system\", content: AgentSkillManagerSystemPrompt, path: options.filepath },\n        ],\n      },\n    });\n  }\n\n  constructor(options: AgentSkillManagerOptions<I, O>) {\n    super({\n      ...options,\n      instructions: options.instructions || AgentSkillManagerSystemPrompt,\n    });\n  }\n}\n"],"mappings":";;;;AAYA,IAAqB,yBAArB,cAGU,QAAc;CACtB,aAAsB,KAAuD,SAGpD;EAEvB,MAAM,QAAQ,MADC,QAAQ,OAA0B,QAAQ,CAC9B,WAAW,QAAQ,OAAO;AACrD,SAAO,QAAQ,KAAK;GAClB,GAAG;GACH,QAAQ;IACN,GAAG,QAAQ;IACX,cAAc,MAAM,gBAAgB,CAClC;KAAE,MAAM;KAAU,SAAS;KAA+B,MAAM,QAAQ;KAAU,CACnF;IACF;GACF,CAAC;;CAGJ,YAAY,SAAyC;AACnD,QAAM;GACJ,GAAG;GACH,cAAc,QAAQ,gBAAgB;GACvC,CAAC"}

package/{lib/esm/agent-skill-manager/prompt.js → dist/agent-skill-manager/prompt.cjs}

@@ -1,4 +1,6 @@
-export const AgentSkillManagerSystemPrompt = `\
+
+//#region src/agent-skill-manager/prompt.ts
+const AgentSkillManagerSystemPrompt = `\
 You are an interactive CLI tool that helps users according to your "Output Style" below, which describes how you should respond to user queries. Use the instructions below and the tools available to you to assist the user.
 
 IMPORTANT: You must NEVER generate or guess URLs for the user unless you are confident that the URLs are for helping the user with programming. You may use URLs provided by the user in their messages or local files.
@@ -15,9 +17,9 @@ IMPORTANT: You must NEVER generate or guess URLs for the user unless you are con
 
 {{ $afs.description }}
 
-${"```"}yaml alt="AFS Modules"
+\`\`\`yaml alt="AFS Modules"
 {{ $afs.modules | yaml.stringify }}
-${"```"}
+\`\`\`
 {% endif %}
 
 # Asking questions as you work
@@ -49,3 +51,6 @@ The user will primarily request you perform software engineering tasks. This inc
 
 IMPORTANT: Complete tasks fully. Do not stop mid-task or leave work incomplete. Do not claim a task is too large, that you lack time, or that context limits prevent completion. You have unlimited context through summarization. Continue working until the task is done or the user stops you.
 `;
+
+//#endregion
+exports.AgentSkillManagerSystemPrompt = AgentSkillManagerSystemPrompt;

package/{lib/cjs/agent-skill-manager/prompt.js → dist/agent-skill-manager/prompt.mjs}

@@ -1,7 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentSkillManagerSystemPrompt = void 0;
-exports.AgentSkillManagerSystemPrompt = `\
+//#region src/agent-skill-manager/prompt.ts
+const AgentSkillManagerSystemPrompt = `\
 You are an interactive CLI tool that helps users according to your "Output Style" below, which describes how you should respond to user queries. Use the instructions below and the tools available to you to assist the user.
 
 IMPORTANT: You must NEVER generate or guess URLs for the user unless you are confident that the URLs are for helping the user with programming. You may use URLs provided by the user in their messages or local files.
@@ -18,9 +16,9 @@ IMPORTANT: You must NEVER generate or guess URLs for the user unless you are con
 
 {{ $afs.description }}
 
-${"```"}yaml alt="AFS Modules"
+\`\`\`yaml alt="AFS Modules"
 {{ $afs.modules | yaml.stringify }}
-${"```"}
+\`\`\`
 {% endif %}
 
 # Asking questions as you work
@@ -52,3 +50,7 @@ The user will primarily request you perform software engineering tasks. This inc
 
 IMPORTANT: Complete tasks fully. Do not stop mid-task or leave work incomplete. Do not claim a task is too large, that you lack time, or that context limits prevent completion. You have unlimited context through summarization. Continue working until the task is done or the user stops you.
 `;
+
+//#endregion
+export { AgentSkillManagerSystemPrompt };
+//# sourceMappingURL=prompt.mjs.map

package/dist/agent-skill-manager/prompt.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.mjs","names":[],"sources":["../../src/agent-skill-manager/prompt.ts"],"sourcesContent":["export const AgentSkillManagerSystemPrompt = `\\\nYou are an interactive CLI tool that helps users according to your \"Output Style\" below, which describes how you should respond to user queries. Use the instructions below and the tools available to you to assist the user.\n\nIMPORTANT: You must NEVER generate or guess URLs for the user unless you are confident that the URLs are for helping the user with programming. You may use URLs provided by the user in their messages or local files.\n\n# Tone and style\n- Only use emojis if the user explicitly requests it. Avoid using emojis in all communication unless asked.\n- Your output will be displayed on a command line interface. Your responses should be short and concise. You can use Github-flavored markdown for formatting, and will be rendered in a monospace font using the CommonMark specification.\n- Output text to communicate with the user; all text you output outside of tool use is displayed to the user. Only use tools to complete tasks. Never use tools like Bash or code comments as means to communicate with the user during the session.\n- NEVER create files unless they're absolutely necessary for achieving your goal. ALWAYS prefer editing an existing file to creating a new one. This includes markdown files.\n- Do not use a colon before tool calls. Your tool calls may not be shown directly in the output, so text like \"Let me read the file:\" followed by a read tool call should just be \"Let me read the file.\" with a period.\n\n{% if $afs.enabled %}\n# AFS Context\n\n{{ $afs.description }}\n\n${\"```\"}yaml alt=\"AFS Modules\"\n{{ $afs.modules | yaml.stringify }}\n${\"```\"}\n{% endif %}\n\n# Asking questions as you work\n\nYou have access to the askUserQuestion tool to ask the user questions when you need clarification, want to validate assumptions, or need to make a decision you're unsure about. When presenting options or plans, never include time estimates - focus on what each option involves, not how long it takes.\n\n# Skill usage\n\nWhen the user requests you to perform tasks, check if any of the available skills can help complete the task more effectively. Skills provide specialized capabilities and domain knowledge.\n\n## Loading skill resources on demand\n\nSkills may include reference documents (guides, schemas, examples) in a \\`references/\\` directory. To optimize performance and context usage:\n\n1. **Start with the main skill file** (e.g., \\`SKILL.md\\`) - it contains the workflow overview and references to detailed guides\n2. **Load reference documents only when needed** - read specific guides only when you reach the step that requires them\n3. **Don't preload all resources** - avoid reading all reference files at the start of a task\n\n# Doing tasks\nThe user will primarily request you perform software engineering tasks. This includes solving bugs, adding new functionality, refactoring code, explaining code, and more. For these tasks the following steps are recommended:\n- NEVER propose changes to code you haven't read. If a user asks about or wants you to modify a file, read it first. Understand existing code before suggesting modifications.\n- Use the askUserQuestion tool to ask questions, clarify and gather information as needed.\n- Be careful not to introduce security vulnerabilities such as command injection, XSS, SQL injection, and other OWASP top 10 vulnerabilities. If you notice that you wrote insecure code, immediately fix it.\n- Avoid over-engineering. Only make changes that are directly requested or clearly necessary. Keep solutions simple and focused.\n  - Don't add features, refactor code, or make \"improvements\" beyond what was asked. A bug fix doesn't need surrounding code cleaned up. A simple feature doesn't need extra configurability. Don't add docstrings, comments, or type annotations to code you didn't change. Only add comments where the logic isn't self-evident.\n  - Don't add error handling, fallbacks, or validation for scenarios that can't happen. Trust internal code and framework guarantees. Only validate at system boundaries (user input, external APIs). Don't use feature flags or backwards-compatibility shims when you can just change the code.\n  - Don't create helpers, utilities, or abstractions for one-time operations. Don't design for hypothetical future requirements. The right amount of complexity is the minimum needed for the current task—three similar lines of code is better than a premature abstraction.\n- Avoid backwards-compatibility hacks like renaming unused \\`_vars\\`, re-exporting types, adding \\`// removed\\` comments for removed code, etc. If something is unused, delete it completely.\n\nIMPORTANT: Complete tasks fully. Do not stop mid-task or leave work incomplete. Do not claim a task is too large, that you lack time, or that context limits prevent completion. You have unlimited context through summarization. Continue working until the task is done or the user stops you.\n`;\n"],"mappings":";AAAA,MAAa,gCAAgC"}

package/dist/ask-user-question/index.cjs

@@ -0,0 +1,88 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+let _aigne_core = require("@aigne/core");
+let _aigne_core_loader_schema = require("@aigne/core/loader/schema");
+let zod = require("zod");
+
+//#region src/ask-user-question/index.ts
+const askUserQuestionAgentOptionSchema = zod.z.object({
+	label: zod.z.string().describe("The display text for this option (1-5 words)"),
+	description: (0, _aigne_core_loader_schema.optionalize)(zod.z.string()).describe("Explanation of what this option means")
+});
+const askUserQuestionAgentInputSchema = zod.z.object({
+	questions: zod.z.array(zod.z.object({
+		header: zod.z.string().describe("Very short label (max 12 chars) used as key in answers. Examples: 'Auth method', 'Library', 'Approach'"),
+		question: zod.z.string().describe("The question to ask the user"),
+		options: (0, _aigne_core_loader_schema.optionalize)(zod.z.array(askUserQuestionAgentOptionSchema)).describe("List of options to present to the user"),
+		multipleSelect: (0, _aigne_core_loader_schema.optionalize)(zod.z.boolean()).describe("Whether to allow multiple selections")
+	})).describe("List of questions to ask the user"),
+	allowCustomAnswer: (0, _aigne_core_loader_schema.optionalize)(zod.z.boolean()).describe("Whether to allow the user to provide custom answers")
+});
+var AskUserQuestionAgent = class AskUserQuestionAgent extends _aigne_core.Agent {
+	tag = "AskUserQuestion";
+	static schema() {
+		return zod.z.object({});
+	}
+	static async load(options) {
+		return new AskUserQuestionAgent({
+			name: defaultName,
+			description: defaultDescription,
+			...options.parsed,
+			inputSchema: askUserQuestionAgentInputSchema
+		});
+	}
+	constructor(options) {
+		super({
+			...options,
+			name: options?.name || defaultName,
+			description: options?.description || defaultDescription,
+			inputSchema: options?.inputSchema || askUserQuestionAgentInputSchema
+		});
+	}
+	async process(input, options) {
+		const { prompts } = options;
+		if (!prompts) throw new Error("Prompts is not available in AskUserQuestionAgent");
+		const { questions, allowCustomAnswer } = input;
+		const answers = {};
+		for (const q of questions) {
+			let answer;
+			if (q.options?.length) {
+				const choices = q.options.map((opt) => ({
+					value: opt.label,
+					name: opt.label,
+					description: opt.description ?? opt.label
+				}));
+				if (allowCustomAnswer) choices.push({
+					name: "None of the above / Enter my own response",
+					value: "OTHER_OPTION"
+				});
+				if (!q.multipleSelect) answer = await prompts.select({
+					message: q.question,
+					choices
+				});
+				else answer = await prompts.checkbox({
+					message: q.question,
+					choices
+				});
+				if (answer === "OTHER_OPTION" || Array.isArray(answer) && answer.includes("OTHER_OPTION")) answer = await prompts.input({ message: `Please provide your response for: ${q.question}` });
+			} else answer = await prompts.input({ message: q.question });
+			answers[q.header] = Array.isArray(answer) ? answer.join(", ") : answer;
+		}
+		return { answers };
+	}
+};
+const defaultName = "askUserQuestion";
+const defaultDescription = `\
+Use this tool when you need to ask the user questions during execution. This allows you to:
+1. Gather user preferences or requirements
+2. Clarify ambiguous instructions
+3. Get decisions on implementation choices as you work
+4. Offer choices to the user about what direction to take.
+
+Usage notes:
+- Users will always be able to select "Other" to provide custom text input
+- Use multiSelect: true to allow multiple answers to be selected for a question
+- If you recommend a specific option, make that the first option in the list and add "(Recommended)" at the end of the label
+`;
+
+//#endregion
+module.exports = AskUserQuestionAgent;

package/dist/ask-user-question/index.d.cts

@@ -0,0 +1,33 @@
+import { Agent, AgentInvokeOptions, AgentOptions, AgentProcessResult, Message } from "@aigne/core";
+import { z as z$1 } from "zod";
+
+//#region src/ask-user-question/index.d.ts
+interface AskUserQuestionAgentOption {
+  label: string;
+  description?: string;
+}
+interface AskUserQuestionAgentInput extends Message {
+  questions: {
+    header: string;
+    question: string;
+    options?: AskUserQuestionAgentOption[];
+    multipleSelect?: boolean;
+  }[];
+  allowCustomAnswer?: boolean;
+}
+interface AskUserQuestionAgentOutput extends Message {
+  answers: Record<string, string>;
+}
+declare class AskUserQuestionAgent extends Agent<AskUserQuestionAgentInput, AskUserQuestionAgentOutput> {
+  tag: string;
+  static schema(): z$1.ZodObject<{}, "strip", z$1.ZodTypeAny, {}, {}>;
+  static load<I extends Message = any, O extends Message = any>(options: {
+    filepath: string;
+    parsed: object;
+  }): Promise<Agent<I, O>>;
+  constructor(options?: AgentOptions<AskUserQuestionAgentInput, AskUserQuestionAgentOutput>);
+  process(input: AskUserQuestionAgentInput, options: AgentInvokeOptions): Promise<AgentProcessResult<AskUserQuestionAgentOutput>>;
+}
+//#endregion
+export { AskUserQuestionAgentInput, AskUserQuestionAgentOption, AskUserQuestionAgentOutput, AskUserQuestionAgent as default };
+//# sourceMappingURL=index.d.cts.map

package/dist/ask-user-question/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/ask-user-question/index.ts"],"mappings":";;;;UAUiB,0BAAA;EAAA,KAAA;EAAA,WAAA;AAAA;AAAA,UAKA,yBAAA,SAAkC,OAAA;EAAA,SAAA;IAAA,MAAA;IAAA,QAAA;IAAA,OAAA,GAIrC,0BAAA;IAAA,cAAA;EAAA;EAAA,iBAAA;AAAA;AAAA,UAiCG,0BAAA,SAAmC,OAAA;EAAA,OAAA,EACzC,MAAA;AAAA;AAAA,cAGU,oBAAA,SAA6B,KAAA,CAChD,yBAAA,EACA,0BAAA;EAAA,GAAA;EAAA,OAAA,OAAA,GAIa,GAAA,CAAA,SAAA,cAAA,GAAA,CAAA,UAAA;EAAA,OAAA,IAAA,WAIwB,OAAA,kBAAyB,OAAA,OAAA,CAAA,OAAA;IAAA,QAAA;IAAA,MAAA;EAAA,IAG1D,OAAA,CAAQ,KAAA,CAAM,CAAA,EAAG,CAAA;EAAA,YAAA,OAAA,GASC,YAAA,CAAa,yBAAA,EAA2B,0BAAA;EAAA,QAAA,KAAA,EAUrD,yBAAA,EAAA,OAAA,EACE,kBAAA,GACR,OAAA,CAAQ,kBAAA,CAAmB,0BAAA;AAAA"}

package/dist/ask-user-question/index.d.mts

@@ -0,0 +1,33 @@
+import { Agent, AgentInvokeOptions, AgentOptions, AgentProcessResult, Message } from "@aigne/core";
+import { z as z$1 } from "zod";
+
+//#region src/ask-user-question/index.d.ts
+interface AskUserQuestionAgentOption {
+  label: string;
+  description?: string;
+}
+interface AskUserQuestionAgentInput extends Message {
+  questions: {
+    header: string;
+    question: string;
+    options?: AskUserQuestionAgentOption[];
+    multipleSelect?: boolean;
+  }[];
+  allowCustomAnswer?: boolean;
+}
+interface AskUserQuestionAgentOutput extends Message {
+  answers: Record<string, string>;
+}
+declare class AskUserQuestionAgent extends Agent<AskUserQuestionAgentInput, AskUserQuestionAgentOutput> {
+  tag: string;
+  static schema(): z$1.ZodObject<{}, "strip", z$1.ZodTypeAny, {}, {}>;
+  static load<I extends Message = any, O extends Message = any>(options: {
+    filepath: string;
+    parsed: object;
+  }): Promise<Agent<I, O>>;
+  constructor(options?: AgentOptions<AskUserQuestionAgentInput, AskUserQuestionAgentOutput>);
+  process(input: AskUserQuestionAgentInput, options: AgentInvokeOptions): Promise<AgentProcessResult<AskUserQuestionAgentOutput>>;
+}
+//#endregion
+export { AskUserQuestionAgentInput, AskUserQuestionAgentOption, AskUserQuestionAgentOutput, AskUserQuestionAgent as default };
+//# sourceMappingURL=index.d.mts.map

package/dist/ask-user-question/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/ask-user-question/index.ts"],"mappings":";;;;UAUiB,0BAAA;EAAA,KAAA;EAAA,WAAA;AAAA;AAAA,UAKA,yBAAA,SAAkC,OAAA;EAAA,SAAA;IAAA,MAAA;IAAA,QAAA;IAAA,OAAA,GAIrC,0BAAA;IAAA,cAAA;EAAA;EAAA,iBAAA;AAAA;AAAA,UAiCG,0BAAA,SAAmC,OAAA;EAAA,OAAA,EACzC,MAAA;AAAA;AAAA,cAGU,oBAAA,SAA6B,KAAA,CAChD,yBAAA,EACA,0BAAA;EAAA,GAAA;EAAA,OAAA,OAAA,GAIa,GAAA,CAAA,SAAA,cAAA,GAAA,CAAA,UAAA;EAAA,OAAA,IAAA,WAIwB,OAAA,kBAAyB,OAAA,OAAA,CAAA,OAAA;IAAA,QAAA;IAAA,MAAA;EAAA,IAG1D,OAAA,CAAQ,KAAA,CAAM,CAAA,EAAG,CAAA;EAAA,YAAA,OAAA,GASC,YAAA,CAAa,yBAAA,EAA2B,0BAAA;EAAA,QAAA,KAAA,EAUrD,yBAAA,EAAA,OAAA,EACE,kBAAA,GACR,OAAA,CAAQ,kBAAA,CAAmB,0BAAA;AAAA"}

package/dist/ask-user-question/index.mjs

@@ -0,0 +1,88 @@
+import { Agent } from "@aigne/core";
+import { optionalize } from "@aigne/core/loader/schema";
+import { z as z$1 } from "zod";
+
+//#region src/ask-user-question/index.ts
+const askUserQuestionAgentOptionSchema = z$1.object({
+	label: z$1.string().describe("The display text for this option (1-5 words)"),
+	description: optionalize(z$1.string()).describe("Explanation of what this option means")
+});
+const askUserQuestionAgentInputSchema = z$1.object({
+	questions: z$1.array(z$1.object({
+		header: z$1.string().describe("Very short label (max 12 chars) used as key in answers. Examples: 'Auth method', 'Library', 'Approach'"),
+		question: z$1.string().describe("The question to ask the user"),
+		options: optionalize(z$1.array(askUserQuestionAgentOptionSchema)).describe("List of options to present to the user"),
+		multipleSelect: optionalize(z$1.boolean()).describe("Whether to allow multiple selections")
+	})).describe("List of questions to ask the user"),
+	allowCustomAnswer: optionalize(z$1.boolean()).describe("Whether to allow the user to provide custom answers")
+});
+var AskUserQuestionAgent = class AskUserQuestionAgent extends Agent {
+	tag = "AskUserQuestion";
+	static schema() {
+		return z$1.object({});
+	}
+	static async load(options) {
+		return new AskUserQuestionAgent({
+			name: defaultName,
+			description: defaultDescription,
+			...options.parsed,
+			inputSchema: askUserQuestionAgentInputSchema
+		});
+	}
+	constructor(options) {
+		super({
+			...options,
+			name: options?.name || defaultName,
+			description: options?.description || defaultDescription,
+			inputSchema: options?.inputSchema || askUserQuestionAgentInputSchema
+		});
+	}
+	async process(input, options) {
+		const { prompts } = options;
+		if (!prompts) throw new Error("Prompts is not available in AskUserQuestionAgent");
+		const { questions, allowCustomAnswer } = input;
+		const answers = {};
+		for (const q of questions) {
+			let answer;
+			if (q.options?.length) {
+				const choices = q.options.map((opt) => ({
+					value: opt.label,
+					name: opt.label,
+					description: opt.description ?? opt.label
+				}));
+				if (allowCustomAnswer) choices.push({
+					name: "None of the above / Enter my own response",
+					value: "OTHER_OPTION"
+				});
+				if (!q.multipleSelect) answer = await prompts.select({
+					message: q.question,
+					choices
+				});
+				else answer = await prompts.checkbox({
+					message: q.question,
+					choices
+				});
+				if (answer === "OTHER_OPTION" || Array.isArray(answer) && answer.includes("OTHER_OPTION")) answer = await prompts.input({ message: `Please provide your response for: ${q.question}` });
+			} else answer = await prompts.input({ message: q.question });
+			answers[q.header] = Array.isArray(answer) ? answer.join(", ") : answer;
+		}
+		return { answers };
+	}
+};
+const defaultName = "askUserQuestion";
+const defaultDescription = `\
+Use this tool when you need to ask the user questions during execution. This allows you to:
+1. Gather user preferences or requirements
+2. Clarify ambiguous instructions
+3. Get decisions on implementation choices as you work
+4. Offer choices to the user about what direction to take.
+
+Usage notes:
+- Users will always be able to select "Other" to provide custom text input
+- Use multiSelect: true to allow multiple answers to be selected for a question
+- If you recommend a specific option, make that the first option in the list and add "(Recommended)" at the end of the label
+`;
+
+//#endregion
+export { AskUserQuestionAgent as default };
+//# sourceMappingURL=index.mjs.map

package/dist/ask-user-question/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["z"],"sources":["../../src/ask-user-question/index.ts"],"sourcesContent":["import {\n  Agent,\n  type AgentInvokeOptions,\n  type AgentOptions,\n  type AgentProcessResult,\n  type Message,\n} from \"@aigne/core\";\nimport { optionalize } from \"@aigne/core/loader/schema\";\nimport { z } from \"zod\";\n\nexport interface AskUserQuestionAgentOption {\n  label: string;\n  description?: string;\n}\n\nexport interface AskUserQuestionAgentInput extends Message {\n  questions: {\n    header: string;\n    question: string;\n    options?: AskUserQuestionAgentOption[];\n    multipleSelect?: boolean;\n  }[];\n  allowCustomAnswer?: boolean;\n}\n\nconst askUserQuestionAgentOptionSchema = z.object({\n  label: z.string().describe(\"The display text for this option (1-5 words)\"),\n  description: optionalize(z.string()).describe(\"Explanation of what this option means\"),\n});\n\nconst askUserQuestionAgentInputSchema = z.object({\n  questions: z\n    .array(\n      z.object({\n        header: z\n          .string()\n          .describe(\n            \"Very short label (max 12 chars) used as key in answers. Examples: 'Auth method', 'Library', 'Approach'\",\n          ),\n        question: z.string().describe(\"The question to ask the user\"),\n        options: optionalize(z.array(askUserQuestionAgentOptionSchema)).describe(\n          \"List of options to present to the user\",\n        ),\n        multipleSelect: optionalize(z.boolean()).describe(\"Whether to allow multiple selections\"),\n      }),\n    )\n    .describe(\"List of questions to ask the user\"),\n  allowCustomAnswer: optionalize(z.boolean()).describe(\n    \"Whether to allow the user to provide custom answers\",\n  ),\n});\n\nexport interface AskUserQuestionAgentOutput extends Message {\n  answers: Record<string, string>;\n}\n\nexport default class AskUserQuestionAgent extends Agent<\n  AskUserQuestionAgentInput,\n  AskUserQuestionAgentOutput\n> {\n  override tag = \"AskUserQuestion\";\n\n  static schema() {\n    return z.object({});\n  }\n\n  static override async load<I extends Message = any, O extends Message = any>(options: {\n    filepath: string;\n    parsed: object;\n  }): Promise<Agent<I, O>> {\n    return new AskUserQuestionAgent({\n      name: defaultName,\n      description: defaultDescription,\n      ...options.parsed,\n      inputSchema: askUserQuestionAgentInputSchema,\n    }) as unknown as Agent<I, O>;\n  }\n\n  constructor(options?: AgentOptions<AskUserQuestionAgentInput, AskUserQuestionAgentOutput>) {\n    super({\n      ...options,\n      name: options?.name || defaultName,\n      description: options?.description || defaultDescription,\n      inputSchema: options?.inputSchema || askUserQuestionAgentInputSchema,\n    });\n  }\n\n  override async process(\n    input: AskUserQuestionAgentInput,\n    options: AgentInvokeOptions,\n  ): Promise<AgentProcessResult<AskUserQuestionAgentOutput>> {\n    const { prompts } = options;\n    if (!prompts) throw new Error(\"Prompts is not available in AskUserQuestionAgent\");\n\n    const { questions, allowCustomAnswer } = input;\n\n    const answers: AskUserQuestionAgentOutput[\"answers\"] = {};\n\n    for (const q of questions) {\n      let answer: string | string[];\n\n      if (q.options?.length) {\n        const choices: { value: string; name?: string; description?: string }[] = q.options.map(\n          (opt) => ({\n            value: opt.label,\n            name: opt.label,\n            description: opt.description ?? opt.label,\n          }),\n        );\n\n        if (allowCustomAnswer) {\n          choices.push({\n            name: \"None of the above / Enter my own response\",\n            value: \"OTHER_OPTION\",\n          });\n        }\n\n        if (!q.multipleSelect) {\n          answer = await prompts.select({\n            message: q.question,\n            choices,\n          });\n        } else {\n          answer = await prompts.checkbox({\n            message: q.question,\n            choices,\n          });\n        }\n\n        if (\n          answer === \"OTHER_OPTION\" ||\n          (Array.isArray(answer) && answer.includes(\"OTHER_OPTION\"))\n        ) {\n          answer = await prompts.input({\n            message: `Please provide your response for: ${q.question}`,\n          });\n        }\n      } else {\n        answer = await prompts.input({\n          message: q.question,\n        });\n      }\n\n      answers[q.header] = Array.isArray(answer) ? answer.join(\", \") : answer;\n    }\n\n    return {\n      answers,\n    };\n  }\n}\n\nconst defaultName = \"askUserQuestion\";\nconst defaultDescription = `\\\nUse this tool when you need to ask the user questions during execution. This allows you to:\n1. Gather user preferences or requirements\n2. Clarify ambiguous instructions\n3. Get decisions on implementation choices as you work\n4. Offer choices to the user about what direction to take.\n\nUsage notes:\n- Users will always be able to select \"Other\" to provide custom text input\n- Use multiSelect: true to allow multiple answers to be selected for a question\n- If you recommend a specific option, make that the first option in the list and add \"(Recommended)\" at the end of the label\n`;\n"],"mappings":";;;;;AAyBA,MAAM,mCAAmCA,IAAE,OAAO;CAChD,OAAOA,IAAE,QAAQ,CAAC,SAAS,+CAA+C;CAC1E,aAAa,YAAYA,IAAE,QAAQ,CAAC,CAAC,SAAS,wCAAwC;CACvF,CAAC;AAEF,MAAM,kCAAkCA,IAAE,OAAO;CAC/C,WAAWA,IACR,MACCA,IAAE,OAAO;EACP,QAAQA,IACL,QAAQ,CACR,SACC,yGACD;EACH,UAAUA,IAAE,QAAQ,CAAC,SAAS,+BAA+B;EAC7D,SAAS,YAAYA,IAAE,MAAM,iCAAiC,CAAC,CAAC,SAC9D,yCACD;EACD,gBAAgB,YAAYA,IAAE,SAAS,CAAC,CAAC,SAAS,uCAAuC;EAC1F,CAAC,CACH,CACA,SAAS,oCAAoC;CAChD,mBAAmB,YAAYA,IAAE,SAAS,CAAC,CAAC,SAC1C,sDACD;CACF,CAAC;AAMF,IAAqB,uBAArB,MAAqB,6BAA6B,MAGhD;CACA,AAAS,MAAM;CAEf,OAAO,SAAS;AACd,SAAOA,IAAE,OAAO,EAAE,CAAC;;CAGrB,aAAsB,KAAuD,SAGpD;AACvB,SAAO,IAAI,qBAAqB;GAC9B,MAAM;GACN,aAAa;GACb,GAAG,QAAQ;GACX,aAAa;GACd,CAAC;;CAGJ,YAAY,SAA+E;AACzF,QAAM;GACJ,GAAG;GACH,MAAM,SAAS,QAAQ;GACvB,aAAa,SAAS,eAAe;GACrC,aAAa,SAAS,eAAe;GACtC,CAAC;;CAGJ,MAAe,QACb,OACA,SACyD;EACzD,MAAM,EAAE,YAAY;AACpB,MAAI,CAAC,QAAS,OAAM,IAAI,MAAM,mDAAmD;EAEjF,MAAM,EAAE,WAAW,sBAAsB;EAEzC,MAAM,UAAiD,EAAE;AAEzD,OAAK,MAAM,KAAK,WAAW;GACzB,IAAI;AAEJ,OAAI,EAAE,SAAS,QAAQ;IACrB,MAAM,UAAoE,EAAE,QAAQ,KACjF,SAAS;KACR,OAAO,IAAI;KACX,MAAM,IAAI;KACV,aAAa,IAAI,eAAe,IAAI;KACrC,EACF;AAED,QAAI,kBACF,SAAQ,KAAK;KACX,MAAM;KACN,OAAO;KACR,CAAC;AAGJ,QAAI,CAAC,EAAE,eACL,UAAS,MAAM,QAAQ,OAAO;KAC5B,SAAS,EAAE;KACX;KACD,CAAC;QAEF,UAAS,MAAM,QAAQ,SAAS;KAC9B,SAAS,EAAE;KACX;KACD,CAAC;AAGJ,QACE,WAAW,kBACV,MAAM,QAAQ,OAAO,IAAI,OAAO,SAAS,eAAe,CAEzD,UAAS,MAAM,QAAQ,MAAM,EAC3B,SAAS,qCAAqC,EAAE,YACjD,CAAC;SAGJ,UAAS,MAAM,QAAQ,MAAM,EAC3B,SAAS,EAAE,UACZ,CAAC;AAGJ,WAAQ,EAAE,UAAU,MAAM,QAAQ,OAAO,GAAG,OAAO,KAAK,KAAK,GAAG;;AAGlE,SAAO,EACL,SACD;;;AAIL,MAAM,cAAc;AACpB,MAAM,qBAAqB"}