@amical/aiagent-sdk 0.1.10 → 0.1.11

package/dist/index.d.mts

@@ -180,6 +180,43 @@ declare function setDynamicToolUseNames(namespace: string, names: string[]): voi
 declare function getToolUseNames(): string[];
 declare const READ_ONLY_TOOLS: readonly [AgentDefaultTool.LIST_FILES, AgentDefaultTool.FILE_READ, AgentDefaultTool.SEARCH, AgentDefaultTool.SEARCH_CONTENT, AgentDefaultTool.LIST_CODE_DEF, AgentDefaultTool.BROWSER, AgentDefaultTool.ASK, AgentDefaultTool.WEB_SEARCH, AgentDefaultTool.WEB_FETCH, AgentDefaultTool.LOAD_SKILL, AgentDefaultTool.USE_SUBAGENTS];
 
+/**
+ * 自定义工具的数据结构与渲染辅助函数。
+ *
+ * 自定义工具支持“工具集（tool group）”结构：
+ * - 顶层只展示工具集入口（name/description/params），避免系统提示词臃肿。
+ * - 当 Agent 调用某个工具集入口时，才把该集合的 children 注册为可用工具，
+ *   并将其 prompt 描述作为工具调用结果返回给模型。
+ */
+interface CustomToolDefinition {
+    name: string;
+    description: string;
+    params?: Record<string, string>;
+    onCall?: (params: Record<string, any>) => Promise<any> | any;
+    /**
+     * 子工具。存在时表示该工具为“工具集入口”，初始不展开 children。
+     */
+    children?: CustomToolDefinition[];
+}
+/**
+ * 判断一个自定义工具是否为工具集入口。
+ */
+declare function isCustomToolGroup(tool: CustomToolDefinition): boolean;
+/**
+ * 递归收集所有自定义工具名（含嵌套 children），用于全局唯一性校验。
+ */
+declare function collectCustomToolNames(tools: CustomToolDefinition[]): string[];
+/**
+ * 将单个工具定义渲染为系统提示词中的工具说明块。
+ *
+ * 注意：该函数只渲染工具自身的 name/description/params，不会展开 children。
+ */
+declare function renderCustomToolPrompt(tool: CustomToolDefinition, cwd?: string): string;
+/**
+ * 批量渲染工具说明。
+ */
+declare function renderCustomToolsPrompt(tools: CustomToolDefinition[], cwd?: string): string;
+
 /**
  * @description **Version 2**
  * Parses an assistant message string potentially containing mixed text and tool usage blocks
@@ -417,7 +454,7 @@ interface AgentOptions {
     promptManager: IPromptManager;
     memory: IMemoryManager;
     mcp?: IMcpManager;
-    customTools?: any[];
+    customTools?: CustomToolDefinition[];
     allowDefaultTools?: string[];
     customInstructions?: string;
     /** 最大循环次数，默认150 */
@@ -451,10 +488,20 @@ declare class ClineAgent {
     private maxLoopCount;
     skillDir: string;
     rulesDir: string;
-    customTools: any[];
+    customTools: CustomToolDefinition[];
+    /** 当前可用（已展开集合）的顶层工具列表，传给 PromptManager 渲染 */
+    activeCustomTools: CustomToolDefinition[];
+    /** 所有已知工具名（含未激活 children），便于查找定义 */
+    customToolsByName: Map<string, CustomToolDefinition>;
     customToolNames: Set<string>;
     allowDefaultTools?: string[];
     customInstructions?: string;
+    /** 已激活的工具集入口名 */
+    private activatedGroups;
+    /** activeCustomTools 变更版本号，用于 Prompt 缓存失效 */
+    private activeToolsVersion;
+    /** 缓存 sysPrompt 时记录的版本号 */
+    private promptActiveToolsVersion;
     sysPrompt?: string;
     noUseTollSysPrompt?: string;
     onStateChange?: (state: AgentState) => void;
@@ -486,6 +533,14 @@ declare class ClineAgent {
      * 核心任务循环
      */
     private loop;
+    /**
+     * 激活自定义工具集：将入口的 children 注册到活跃工具列表并返回渲染后的 prompt。
+     */
+    private activateCustomToolGroup;
+    /**
+     * 检查自上次获取 prompt 后是否有工具集被激活，若有则刷新缓存。
+     */
+    private getCurrentPrompt;
     /**
      * 简单的 Diff 解析与替换辅助方法
      */
@@ -513,4 +568,4 @@ declare class ClineAgent {
 
 declare const VERSION = "0.1.0";
 
-export { AgentDefaultTool, type AgentMessage, type AgentOptions, AgentState, type ApiProviderInfo, type ApiStreamChunk, type AssistantMessageContent, ClineAgent, type IAgentRuntime, type IApiHandler, type IMcpManager, type IMemoryManager, type IPromptManager, type McpServerInfo, type McpTool, type McpToolCallResult, READ_ONLY_TOOLS, type ReasoningStreamContent, TOOL_RESULT_BLOCK, type TextStreamContent, type ToolParamName, type ToolUse, VERSION, defaultTools, getToolUseNames, parseAssistantMessageV2, setDynamicToolUseNames, toolParamNames, toolUseNames };
+export { AgentDefaultTool, type AgentMessage, type AgentOptions, AgentState, type ApiProviderInfo, type ApiStreamChunk, type AssistantMessageContent, ClineAgent, type CustomToolDefinition, type IAgentRuntime, type IApiHandler, type IMcpManager, type IMemoryManager, type IPromptManager, type McpServerInfo, type McpTool, type McpToolCallResult, READ_ONLY_TOOLS, type ReasoningStreamContent, TOOL_RESULT_BLOCK, type TextStreamContent, type ToolParamName, type ToolUse, VERSION, collectCustomToolNames, defaultTools, getToolUseNames, isCustomToolGroup, parseAssistantMessageV2, renderCustomToolPrompt, renderCustomToolsPrompt, setDynamicToolUseNames, toolParamNames, toolUseNames };

package/dist/index.d.ts

@@ -180,6 +180,43 @@ declare function setDynamicToolUseNames(namespace: string, names: string[]): voi
 declare function getToolUseNames(): string[];
 declare const READ_ONLY_TOOLS: readonly [AgentDefaultTool.LIST_FILES, AgentDefaultTool.FILE_READ, AgentDefaultTool.SEARCH, AgentDefaultTool.SEARCH_CONTENT, AgentDefaultTool.LIST_CODE_DEF, AgentDefaultTool.BROWSER, AgentDefaultTool.ASK, AgentDefaultTool.WEB_SEARCH, AgentDefaultTool.WEB_FETCH, AgentDefaultTool.LOAD_SKILL, AgentDefaultTool.USE_SUBAGENTS];
 
+/**
+ * 自定义工具的数据结构与渲染辅助函数。
+ *
+ * 自定义工具支持“工具集（tool group）”结构：
+ * - 顶层只展示工具集入口（name/description/params），避免系统提示词臃肿。
+ * - 当 Agent 调用某个工具集入口时，才把该集合的 children 注册为可用工具，
+ *   并将其 prompt 描述作为工具调用结果返回给模型。
+ */
+interface CustomToolDefinition {
+    name: string;
+    description: string;
+    params?: Record<string, string>;
+    onCall?: (params: Record<string, any>) => Promise<any> | any;
+    /**
+     * 子工具。存在时表示该工具为“工具集入口”，初始不展开 children。
+     */
+    children?: CustomToolDefinition[];
+}
+/**
+ * 判断一个自定义工具是否为工具集入口。
+ */
+declare function isCustomToolGroup(tool: CustomToolDefinition): boolean;
+/**
+ * 递归收集所有自定义工具名（含嵌套 children），用于全局唯一性校验。
+ */
+declare function collectCustomToolNames(tools: CustomToolDefinition[]): string[];
+/**
+ * 将单个工具定义渲染为系统提示词中的工具说明块。
+ *
+ * 注意：该函数只渲染工具自身的 name/description/params，不会展开 children。
+ */
+declare function renderCustomToolPrompt(tool: CustomToolDefinition, cwd?: string): string;
+/**
+ * 批量渲染工具说明。
+ */
+declare function renderCustomToolsPrompt(tools: CustomToolDefinition[], cwd?: string): string;
+
 /**
  * @description **Version 2**
  * Parses an assistant message string potentially containing mixed text and tool usage blocks
@@ -417,7 +454,7 @@ interface AgentOptions {
     promptManager: IPromptManager;
     memory: IMemoryManager;
     mcp?: IMcpManager;
-    customTools?: any[];
+    customTools?: CustomToolDefinition[];
     allowDefaultTools?: string[];
     customInstructions?: string;
     /** 最大循环次数，默认150 */
@@ -451,10 +488,20 @@ declare class ClineAgent {
     private maxLoopCount;
     skillDir: string;
     rulesDir: string;
-    customTools: any[];
+    customTools: CustomToolDefinition[];
+    /** 当前可用（已展开集合）的顶层工具列表，传给 PromptManager 渲染 */
+    activeCustomTools: CustomToolDefinition[];
+    /** 所有已知工具名（含未激活 children），便于查找定义 */
+    customToolsByName: Map<string, CustomToolDefinition>;
     customToolNames: Set<string>;
     allowDefaultTools?: string[];
     customInstructions?: string;
+    /** 已激活的工具集入口名 */
+    private activatedGroups;
+    /** activeCustomTools 变更版本号，用于 Prompt 缓存失效 */
+    private activeToolsVersion;
+    /** 缓存 sysPrompt 时记录的版本号 */
+    private promptActiveToolsVersion;
     sysPrompt?: string;
     noUseTollSysPrompt?: string;
     onStateChange?: (state: AgentState) => void;
@@ -486,6 +533,14 @@ declare class ClineAgent {
      * 核心任务循环
      */
     private loop;
+    /**
+     * 激活自定义工具集：将入口的 children 注册到活跃工具列表并返回渲染后的 prompt。
+     */
+    private activateCustomToolGroup;
+    /**
+     * 检查自上次获取 prompt 后是否有工具集被激活，若有则刷新缓存。
+     */
+    private getCurrentPrompt;
     /**
      * 简单的 Diff 解析与替换辅助方法
      */
@@ -513,4 +568,4 @@ declare class ClineAgent {
 
 declare const VERSION = "0.1.0";
 
-export { AgentDefaultTool, type AgentMessage, type AgentOptions, AgentState, type ApiProviderInfo, type ApiStreamChunk, type AssistantMessageContent, ClineAgent, type IAgentRuntime, type IApiHandler, type IMcpManager, type IMemoryManager, type IPromptManager, type McpServerInfo, type McpTool, type McpToolCallResult, READ_ONLY_TOOLS, type ReasoningStreamContent, TOOL_RESULT_BLOCK, type TextStreamContent, type ToolParamName, type ToolUse, VERSION, defaultTools, getToolUseNames, parseAssistantMessageV2, setDynamicToolUseNames, toolParamNames, toolUseNames };
+export { AgentDefaultTool, type AgentMessage, type AgentOptions, AgentState, type ApiProviderInfo, type ApiStreamChunk, type AssistantMessageContent, ClineAgent, type CustomToolDefinition, type IAgentRuntime, type IApiHandler, type IMcpManager, type IMemoryManager, type IPromptManager, type McpServerInfo, type McpTool, type McpToolCallResult, READ_ONLY_TOOLS, type ReasoningStreamContent, TOOL_RESULT_BLOCK, type TextStreamContent, type ToolParamName, type ToolUse, VERSION, collectCustomToolNames, defaultTools, getToolUseNames, isCustomToolGroup, parseAssistantMessageV2, renderCustomToolPrompt, renderCustomToolsPrompt, setDynamicToolUseNames, toolParamNames, toolUseNames };

package/dist/index.js

@@ -285,6 +285,44 @@ var READ_ONLY_TOOLS = [
   "agent_load_skill" /* LOAD_SKILL */,
   "agent_use_subagents" /* USE_SUBAGENTS */
 ];
+
+// src/shared/custom-tools.ts
+function isCustomToolGroup(tool) {
+  return Array.isArray(tool.children) && tool.children.length > 0;
+}
+function collectCustomToolNames(tools) {
+  const names = [];
+  const visit = (list) => {
+    for (const tool of list) {
+      names.push(tool.name);
+      if (Array.isArray(tool.children) && tool.children.length > 0) {
+        visit(tool.children);
+      }
+    }
+  };
+  visit(tools);
+  return names;
+}
+function renderCustomToolPrompt(tool, cwd = "") {
+  const params = tool.params ? Object.entries(tool.params) : [];
+  const replaceCwd = (text) => String(text).replaceAll("${context.cwd}", cwd);
+  const paramLines = params.map(([name, description]) => `- ${name}: ${replaceCwd(description)}`).join("\n");
+  const usageLines = params.map(([name, description]) => `<${name}>${replaceCwd(description)}</${name}>`).join("\n");
+  return `### ${tool.name}
+Description: ${tool.description}
+Parameters: 
+${paramLines}
+- task_progress: (optional) A checklist showing task progress after this tool use is completed. The task_progress parameter must be included as a separate parameter inside of the parent tool call, it must be separate from other parameters such as content, arguments, etc. (See 'UPDATING TASK PROGRESS' section for more details)
+Usage: 
+<${tool.name}>
+${usageLines}
+<task_progress>Checklist here (optional)</task_progress>
+</${tool.name}>
+`;
+}
+function renderCustomToolsPrompt(tools, cwd = "") {
+  return tools.map((tool) => renderCustomToolPrompt(tool, cwd)).join("\n");
+}
 function parseAssistantMessageV2(assistantMessage, toolParamNames2) {
   const contentBlocks = [];
   let currentTextContentStart = 0;
@@ -568,9 +606,19 @@ var ClineAgent = class {
   skillDir;
   rulesDir;
   customTools;
+  /** 当前可用（已展开集合）的顶层工具列表，传给 PromptManager 渲染 */
+  activeCustomTools;
+  /** 所有已知工具名（含未激活 children），便于查找定义 */
+  customToolsByName;
   customToolNames;
   allowDefaultTools;
   customInstructions;
+  /** 已激活的工具集入口名 */
+  activatedGroups = /* @__PURE__ */ new Set();
+  /** activeCustomTools 变更版本号，用于 Prompt 缓存失效 */
+  activeToolsVersion = 0;
+  /** 缓存 sysPrompt 时记录的版本号 */
+  promptActiveToolsVersion = -1;
   sysPrompt;
   noUseTollSysPrompt;
   // 简单的事件回调系统，供宿主环境注册以监听 Agent 内部事件
@@ -590,31 +638,38 @@ var ClineAgent = class {
       this.allowDefaultTools.push("agent_attempt_completion" /* ATTEMPT */);
     }
     this.customInstructions = options.customInstructions;
+    this.customToolsByName = /* @__PURE__ */ new Map();
+    this.activeCustomTools = [...this.customTools];
+    this.customToolNames = new Set(collectCustomToolNames(this.customTools));
     if (this.customTools.length > 0) {
-      const dynamicToolNames = /* @__PURE__ */ new Set();
       const customToolParams = /* @__PURE__ */ new Set();
-      for (const customTool of this.customTools) {
-        dynamicToolNames.add(customTool.name);
-        if (customTool.params) {
-          for (const key in customTool.params) {
-            if (!Object.hasOwn(customTool.params, key)) continue;
-            customToolParams.add(key);
+      const visit = (tools) => {
+        for (const customTool of tools) {
+          this.customToolsByName.set(customTool.name, customTool);
+          if (customTool.params) {
+            for (const key in customTool.params) {
+              if (!Object.hasOwn(customTool.params, key)) continue;
+              customToolParams.add(key);
+            }
+          }
+          if (Array.isArray(customTool.children) && customTool.children.length > 0) {
+            visit(customTool.children);
           }
         }
-      }
+      };
+      visit(this.customTools);
       const defaultToolNames = Object.values(AgentDefaultTool);
-      const overlappingTools = Array.from(dynamicToolNames).filter((name) => defaultToolNames.includes(name));
+      const overlappingTools = Array.from(this.customToolNames).filter((name) => defaultToolNames.includes(name));
       if (overlappingTools.length > 0) {
         throw new Error(`Custom tools and default tools have overlapping names: ${overlappingTools.join(", ")}`);
       }
-      if (dynamicToolNames.size > 0) {
-        setDynamicToolUseNames("customUser", Array.from(dynamicToolNames));
+      if (this.customToolNames.size > 0) {
+        setDynamicToolUseNames("customUser", Array.from(this.customToolNames));
       }
       if (customToolParams.size > 0) {
         this.allToolParamNames = Array.from(/* @__PURE__ */ new Set([...this.allToolParamNames, ...Array.from(customToolParams)]));
       }
     }
-    this.customToolNames = new Set(this.customTools.map((t) => t.name));
     this.skillDir = this.runtime.path.join(this.runtime.env.cwd(), ".agents/skills");
     this.rulesDir = this.runtime.path.join(this.runtime.env.cwd(), ".agents/rules");
   }
@@ -638,10 +693,11 @@ var ClineAgent = class {
       shell: this.runtime.env.shell(),
       skills: await this.getSkills(),
       agentRules: await this.getAgentRules(),
-      customTools: this.customTools,
+      customTools: this.activeCustomTools,
       allowDefaultTools: this.allowDefaultTools,
       customInstructions: this.customInstructions
     };
+    this.promptActiveToolsVersion = this.activeToolsVersion;
     this.sysPrompt = await this.promptManager.getSystemPrompt(context);
     this.noUseTollSysPrompt = this.promptManager.getNoUseToolInstructions(context);
     return { sysPrompt: this.sysPrompt, noUseTollSysPrompt: this.noUseTollSysPrompt };
@@ -750,9 +806,9 @@ ${content.trim()}\`\`\``);
    * 核心任务循环
    */
   async loop() {
-    const { sysPrompt, noUseTollSysPrompt } = await this.getPrompt(true);
-    const { customTools, customToolNames } = this;
+    const { customToolsByName, customToolNames } = this;
     while (this.state === "thinking" /* THINKING */) {
+      const { sysPrompt, noUseTollSysPrompt } = await this.getCurrentPrompt();
       this.loopCount++;
       if (this.loopCount > this.maxLoopCount) {
         await this.memory.appendMessage({
@@ -797,7 +853,33 @@ ${content.trim()}\`\`\``);
             }
           }
           if (customToolNames.has(tool.name)) {
-            const customTool = customTools.find((t) => t.name === tool.name);
+            const customTool = customToolsByName.get(tool.name);
+            if (!customTool) {
+              toolResults.push({ tool, result: `Error: Custom tool "${tool.name}" not found.` });
+              continue;
+            }
+            if (isCustomToolGroup(customTool)) {
+              let groupResult;
+              if (customTool.onCall) {
+                try {
+                  groupResult = await customTool.onCall(tool.params);
+                } catch (error) {
+                  toolResults.push({ tool, result: `Error: ${error.message}` });
+                  continue;
+                }
+              }
+              const childrenPrompt = this.activateCustomToolGroup(customTool);
+              const finalPrompt = `# New Available Tools
+
+The following are instructions for using the new available tools.
+
+${childrenPrompt}`;
+              const promptBlock = groupResult !== void 0 ? `${typeof groupResult === "string" ? groupResult : JSON.stringify(groupResult)}
+
+${finalPrompt}` : finalPrompt;
+              toolResults.push({ tool, result: promptBlock });
+              continue;
+            }
             if (customTool.onCall) {
               try {
                 const res = await customTool.onCall(tool.params);
@@ -1058,6 +1140,27 @@ ${this.promptManager.getUsedToolResultInstructions()}`;
       }
     }
   }
+  /**
+   * 激活自定义工具集：将入口的 children 注册到活跃工具列表并返回渲染后的 prompt。
+   */
+  activateCustomToolGroup(group) {
+    if (this.activatedGroups.has(group.name)) {
+      return renderCustomToolsPrompt(group.children || [], this.runtime.env.cwd());
+    }
+    this.activatedGroups.add(group.name);
+    this.activeCustomTools = [...this.activeCustomTools, ...group.children || []];
+    this.activeToolsVersion++;
+    return renderCustomToolsPrompt(group.children || [], this.runtime.env.cwd());
+  }
+  /**
+   * 检查自上次获取 prompt 后是否有工具集被激活，若有则刷新缓存。
+   */
+  async getCurrentPrompt() {
+    if (this.promptActiveToolsVersion !== this.activeToolsVersion) {
+      return this.getPrompt(true);
+    }
+    return this.getPrompt();
+  }
   /**
    * 简单的 Diff 解析与替换辅助方法
    */
@@ -1230,9 +1333,13 @@ exports.ClineAgent = ClineAgent;
 exports.READ_ONLY_TOOLS = READ_ONLY_TOOLS;
 exports.TOOL_RESULT_BLOCK = TOOL_RESULT_BLOCK;
 exports.VERSION = VERSION;
+exports.collectCustomToolNames = collectCustomToolNames;
 exports.defaultTools = defaultTools;
 exports.getToolUseNames = getToolUseNames;
+exports.isCustomToolGroup = isCustomToolGroup;
 exports.parseAssistantMessageV2 = parseAssistantMessageV2;
+exports.renderCustomToolPrompt = renderCustomToolPrompt;
+exports.renderCustomToolsPrompt = renderCustomToolsPrompt;
 exports.setDynamicToolUseNames = setDynamicToolUseNames;
 exports.toolParamNames = toolParamNames;
 exports.toolUseNames = toolUseNames;