@shareai-lab/kode-sdk 2.7.1 → 2.7.2

package/dist/tools/scripts.js

@@ -0,0 +1,205 @@
+"use strict";
+/**
+ * Scripts 执行工具
+ *
+ * 设计原则 (UNIX哲学):
+ * - 简洁: 只负责执行scripts，支持双模式（直接执行/sandbox隔离）
+ * - 安全: 支持sandbox隔离执行，拦截危险命令
+ * - 跨平台: 自动适配Windows、Linux、MacOS
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createScriptsTool = createScriptsTool;
+const tool_1 = require("../tools/tool");
+const zod_1 = require("zod");
+const child_process_1 = require("child_process");
+const path = __importStar(require("path"));
+const os = __importStar(require("os"));
+/**
+ * Scripts 工具描述
+ */
+const DESCRIPTION = `执行skill中的scripts脚本。
+
+支持两种执行模式:
+- 直接执行模式（默认）: 本地开发时使用，直接在当前环境执行
+- Sandbox隔离模式: 生产环境使用，在安全隔离环境中执行
+
+支持的脚本类型:
+- Node.js脚本 (.js, .ts): 跨平台兼容
+- Shell脚本 (.sh): Linux/MacOS
+- Batch脚本 (.bat): Windows
+
+注意: 危险命令会被自动拦截（如rm -rf /、sudo等）`;
+/**
+ * 检测平台
+ */
+function detectPlatform() {
+    const platform = os.platform();
+    if (platform === 'win32')
+        return 'windows';
+    if (platform === 'darwin')
+        return 'macos';
+    return 'linux';
+}
+/**
+ * 获取脚本执行命令
+ */
+function getScriptCommand(scriptPath, platform) {
+    const ext = path.extname(scriptPath).toLowerCase();
+    switch (ext) {
+        case '.js':
+            return `node "${scriptPath}"`;
+        case '.ts':
+            return `ts-node "${scriptPath}"`;
+        case '.sh':
+            if (platform === 'windows') {
+                // Windows下需要Git Bash或WSL来执行.sh
+                return `bash "${scriptPath}"`;
+            }
+            return `sh "${scriptPath}"`;
+        case '.bat':
+        case '.cmd':
+            if (platform !== 'windows') {
+                throw new Error(`Batch scripts (.bat/.cmd) are only supported on Windows`);
+            }
+            return `"${scriptPath}"`;
+        default:
+            throw new Error(`Unsupported script type: ${ext}`);
+    }
+}
+/**
+ * 创建Scripts工具
+ *
+ * @param skillsManager Skills管理器实例
+ * @param sandboxFactory Sandbox工厂（可选）
+ * @returns ToolInstance
+ */
+function createScriptsTool(skillsManager, sandboxFactory) {
+    const scriptsTool = (0, tool_1.tool)({
+        name: 'execute_script',
+        description: DESCRIPTION,
+        parameters: zod_1.z.object({
+            skill_name: zod_1.z.string().describe('技能名称'),
+            script_name: zod_1.z.string().describe('脚本文件名（如"script.js"）'),
+            use_sandbox: zod_1.z.boolean().optional().default(true).describe('是否使用sandbox隔离执行'),
+            args: zod_1.z.array(zod_1.z.string()).optional().describe('脚本参数（可选）'),
+        }),
+        async execute(args, ctx) {
+            const { skill_name, script_name, use_sandbox, args: scriptArgs = [] } = args;
+            // 加载skill内容
+            const skillContent = await skillsManager.loadSkillContent(skill_name);
+            if (!skillContent) {
+                return {
+                    ok: false,
+                    error: `Skill '${skill_name}' not found`,
+                };
+            }
+            // 查找脚本文件
+            const scriptPath = skillContent.scripts.find(p => path.basename(p) === script_name);
+            if (!scriptPath) {
+                return {
+                    ok: false,
+                    error: `Script '${script_name}' not found in skill '${skill_name}'. Available scripts: ${skillContent.scripts.map(p => path.basename(p)).join(', ')}`,
+                };
+            }
+            const platform = detectPlatform();
+            let result;
+            try {
+                if (use_sandbox && sandboxFactory) {
+                    // 使用sandbox隔离执行
+                    const sandbox = sandboxFactory.create({
+                        kind: 'local',
+                        workDir: skillContent.metadata.baseDir,
+                    });
+                    const cmd = getScriptCommand(scriptPath, platform);
+                    const cmdWithArgs = `${cmd} ${scriptArgs.join(' ')}`;
+                    result = await sandbox.exec(cmdWithArgs, { timeoutMs: 60000 });
+                }
+                else {
+                    // 直接执行（本地开发模式）
+                    const cmd = getScriptCommand(scriptPath, platform);
+                    const cmdWithArgs = `${cmd} ${scriptArgs.join(' ')}`;
+                    const stdout = (0, child_process_1.execSync)(cmdWithArgs, {
+                        cwd: skillContent.metadata.baseDir,
+                        encoding: 'utf-8',
+                        stdio: ['ignore', 'pipe', 'pipe'],
+                        timeout: 60000,
+                    });
+                    result = {
+                        code: 0,
+                        stdout: stdout || '',
+                        stderr: '',
+                    };
+                }
+                if (result.code !== 0) {
+                    return {
+                        ok: false,
+                        error: `Script execution failed with code ${result.code}`,
+                        data: {
+                            stdout: result.stdout,
+                            stderr: result.stderr,
+                        },
+                    };
+                }
+                return {
+                    ok: true,
+                    data: {
+                        stdout: result.stdout,
+                        stderr: result.stderr,
+                    },
+                };
+            }
+            catch (error) {
+                return {
+                    ok: false,
+                    error: error.message || 'Script execution failed',
+                    data: {
+                        stdout: error.stdout || '',
+                        stderr: error.stderr || '',
+                    },
+                };
+            }
+        },
+        metadata: {
+            readonly: false,
+            version: '1.0',
+        },
+    });
+    return scriptsTool;
+}
+/**
+ * 导出工具创建函数
+ */
+exports.default = createScriptsTool;

package/dist/tools/skills.js

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * Skills 工具
+ *
+ * 设计原则 (UNIX哲学):
+ * - 简洁: 只负责列出和加载skills，不处理业务逻辑
+ * - 模块化: 复用SkillsManager进行实际操作
+ * - 组合: 与SDK工具系统无缝集成
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSkillsTool = createSkillsTool;
+const tool_1 = require("../tools/tool");
+const zod_1 = require("zod");
+/**
+ * Skills 工具描述
+ *
+ * 原始描述（已备份，list操作已临时禁用）:
+ * const ORIGINAL_DESCRIPTION = `管理和加载skills。
+ *
+ * 使用此工具来:
+ * - 列出所有可用的skills（获取元数据列表）
+ * - 加载特定skill的详细内容（包含指令、references、scripts、assets）
+ *
+ * Skills是可重用的能力单元，可以扩展Agent的功能。`;
+ */
+const DESCRIPTION = `加载特定skill的详细内容。
+
+使用此工具来:
+- 加载特定skill的详细内容（包含指令、references、scripts、assets）
+- 需要提供skill_name参数来指定要加载的技能
+
+Skills是可重用的能力单元，可以扩展Agent的功能。`;
+/**
+ * 创建Skills工具
+ *
+ * @param skillsManager Skills管理器实例
+ * @returns ToolInstance
+ */
+function createSkillsTool(skillsManager) {
+    // 临时禁用 list 操作，只保留 load 操作
+    // const actionSchema = z.enum(['list', 'load']).describe('操作类型');
+    const actionSchema = zod_1.z.enum(['load']).describe('操作类型');
+    const skillsTool = (0, tool_1.tool)({
+        name: 'skills',
+        description: DESCRIPTION,
+        parameters: zod_1.z.object({
+            action: actionSchema,
+            skill_name: zod_1.z.string().optional().describe('技能名称（当action=load时必需）'),
+        }),
+        async execute(args, ctx) {
+            const { action, skill_name } = args;
+            // 注释掉 list 操作的代码
+            // if (action === 'list') {
+            //   // 列出所有skills
+            //   const skills = await skillsManager.getSkillsMetadata();
+            //
+            //   const skillsList = skills.map(s => ({
+            //     name: s.name,
+            //     description: s.description,
+            //   }));
+            //
+            //   return {
+            //     ok: true,
+            //     data: {
+            //       count: skillsList.length,
+            //       skills: skillsList,
+            //     },
+            //   };
+            // } else if (action === 'load') {
+            if (action === 'load') {
+                // 加载特定skill内容
+                if (!skill_name) {
+                    return {
+                        ok: false,
+                        error: 'skill_name is required when action=load',
+                    };
+                }
+                const content = await skillsManager.loadSkillContent(skill_name);
+                if (!content) {
+                    return {
+                        ok: false,
+                        error: `Skill '${skill_name}' not found`,
+                    };
+                }
+                return {
+                    ok: true,
+                    data: {
+                        name: content.metadata.name,
+                        description: content.metadata.description,
+                        content: content.content,
+                        base_dir: content.metadata.baseDir,
+                        references: content.references,
+                        scripts: content.scripts,
+                        assets: content.assets,
+                    },
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    error: `Unknown action: ${action}`,
+                };
+            }
+        },
+        metadata: {
+            readonly: true,
+            version: '1.0',
+        },
+    });
+    return skillsTool;
+}
+/**
+ * 导出工具创建函数
+ */
+exports.default = createSkillsTool;

package/dist/tools/task_run/index.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTaskRunTool = createTaskRunTool;
+const tool_1 = require("../tool");
+const zod_1 = require("zod");
+const prompt_1 = require("./prompt");
+function createTaskRunTool(templates) {
+    if (!templates || templates.length === 0) {
+        throw new Error('Cannot create task_run tool: no agent templates provided');
+    }
+    const TaskRun = (0, tool_1.tool)({
+        name: 'task_run',
+        description: prompt_1.DESCRIPTION,
+        parameters: zod_1.z.object({
+            description: zod_1.z.string().describe('Short description of the task (3-5 words)'),
+            prompt: zod_1.z.string().describe('Detailed instructions for the sub-agent'),
+            agentTemplateId: zod_1.z.string().describe('Agent template ID to use for this task'),
+            context: zod_1.z.string().optional().describe('Additional context to append'),
+        }),
+        async execute(args, ctx) {
+            const { description, prompt, agentTemplateId, context } = args;
+            const template = templates.find((tpl) => tpl.id === agentTemplateId);
+            if (!template) {
+                const availableTemplates = templates
+                    .map((tpl) => `  - ${tpl.id}: ${tpl.whenToUse || 'General purpose agent'}`)
+                    .join('\n');
+                throw new Error(`Agent template '${agentTemplateId}' not found.\n\nAvailable templates:\n${availableTemplates}\n\nPlease choose one of the available template IDs.`);
+            }
+            const detailedPrompt = [
+                `# Task: ${description}`,
+                prompt,
+                context ? `\n# Additional Context\n${context}` : undefined,
+            ]
+                .filter(Boolean)
+                .join('\n\n');
+            if (!ctx.agent?.delegateTask) {
+                throw new Error('Task delegation not supported by this agent version');
+            }
+            const result = await ctx.agent.delegateTask({
+                templateId: template.id,
+                prompt: detailedPrompt,
+                tools: template.tools,
+            });
+            return {
+                status: result.status,
+                template: template.id,
+                text: result.text,
+                permissionIds: result.permissionIds,
+            };
+        },
+        metadata: {
+            readonly: false,
+            version: '1.0',
+        },
+    });
+    TaskRun.prompt = (0, prompt_1.generatePrompt)(templates);
+    return TaskRun;
+}

package/dist/tools/task_run/prompt.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DESCRIPTION = void 0;
+exports.generatePrompt = generatePrompt;
+exports.DESCRIPTION = 'Delegate a task to a specialized sub-agent';
+function generatePrompt(templates) {
+    const templateList = templates
+        .map((tpl) => `- agentTemplateId: ${tpl.id}\n  whenToUse: ${tpl.whenToUse || 'General purpose tasks'}`)
+        .join('\n');
+    return `Delegate complex, multi-step work to specialized sub-agents.
+
+Instructions:
+- Always provide a concise "description" (3-5 words) and a detailed "prompt" outlining deliverables.
+- REQUIRED: Set "agentTemplateId" to one of the available template IDs below.
+- Optionally supply "context" for extra background information.
+- The tool returns the sub-agent's final text and any pending permissions.
+
+Available agent templates:
+${templateList}
+
+Safety/Limitations:
+- Sub-agents inherit the same sandbox and tool restrictions.
+- Task delegation depth may be limited to prevent infinite recursion.
+- Sub-agents cannot access parent agent state or context directly.`;
+}

package/dist/tools/todo_read/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TodoRead = void 0;
+const tool_1 = require("../tool");
+const zod_1 = require("zod");
+const prompt_1 = require("./prompt");
+exports.TodoRead = (0, tool_1.tool)({
+    name: 'todo_read',
+    description: prompt_1.DESCRIPTION,
+    parameters: zod_1.z.object({}),
+    async execute(_args, ctx) {
+        if (ctx.agent?.getTodos) {
+            return { todos: ctx.agent.getTodos() };
+        }
+        const service = ctx.services?.todo;
+        if (!service) {
+            return {
+                todos: [],
+                note: 'Todo service not enabled for this agent'
+            };
+        }
+        return { todos: service.list() };
+    },
+    metadata: {
+        readonly: true,
+        version: '1.0',
+    },
+});
+exports.TodoRead.prompt = prompt_1.PROMPT;

package/dist/tools/todo_read/prompt.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROMPT = exports.DESCRIPTION = void 0;
+exports.DESCRIPTION = 'Read the current todo list managed by the agent';
+exports.PROMPT = `Retrieve the canonical list of todos that this agent maintains.
+
+Guidelines:
+- Use this before planning or reprioritizing work
+- The returned list reflects the current state of all tracked tasks
+- Each todo includes: id, title, status, and optional assignee/notes
+
+Todo Status Values:
+- pending: Not yet started
+- in_progress: Currently being worked on
+- completed: Finished
+
+Limitations:
+- Returns empty list if todo service is not enabled for this agent`;

package/dist/tools/todo_write/index.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TodoWrite = void 0;
+const tool_1 = require("../tool");
+const zod_1 = require("zod");
+const prompt_1 = require("./prompt");
+const todoItemSchema = zod_1.z.object({
+    id: zod_1.z.string().describe('Unique identifier for the todo'),
+    title: zod_1.z.string().describe('Clear description of the task'),
+    status: zod_1.z.enum(['pending', 'in_progress', 'completed']).describe('Current status'),
+    assignee: zod_1.z.string().optional().describe('Who is responsible'),
+    notes: zod_1.z.string().optional().describe('Additional context'),
+});
+exports.TodoWrite = (0, tool_1.tool)({
+    name: 'todo_write',
+    description: prompt_1.DESCRIPTION,
+    parameters: zod_1.z.object({
+        todos: zod_1.z.array(todoItemSchema).describe('Array of todo items'),
+    }),
+    async execute(args, ctx) {
+        const { todos } = args;
+        const inProgressCount = todos.filter((t) => t.status === 'in_progress').length;
+        if (inProgressCount > 1) {
+            throw new Error(`Only one todo can be "in_progress" at a time. Found ${inProgressCount} in_progress todos.`);
+        }
+        if (!ctx.agent?.setTodos) {
+            const service = ctx.services?.todo;
+            if (!service) {
+                throw new Error('Todo service not enabled for this agent');
+            }
+            await service.setTodos(todos);
+            return { ok: true, count: todos.length };
+        }
+        await ctx.agent.setTodos(todos);
+        return { ok: true, count: todos.length };
+    },
+    metadata: {
+        readonly: false,
+        version: '1.0',
+    },
+});
+exports.TodoWrite.prompt = prompt_1.PROMPT;

package/dist/tools/todo_write/prompt.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROMPT = exports.DESCRIPTION = void 0;
+exports.DESCRIPTION = 'Replace the todo list managed by the agent';
+exports.PROMPT = `Replace the agent-managed todo list with a new array of todos.
+
+Guidelines:
+- Always provide structured IDs, titles, and statuses
+- Only ONE item may have "in_progress" status at any time
+- IDs should be unique and descriptive
+- Titles should be clear and actionable
+
+Todo Structure:
+- id (required): Unique identifier for the todo
+- title (required): Clear description of the task
+- status (required): "pending" | "in_progress" | "completed"
+- assignee (optional): Who is responsible
+- notes (optional): Additional context or details
+
+Safety/Limitations:
+- This operation replaces the entire todo list
+- Previous todos not included in the new list will be removed
+- Returns error if todo service is not enabled`;