@fastgpt-plugin/cli 0.1.0-alpha.1

package/README.md

@@ -0,0 +1,35 @@
+## @fastgpt-plugin/cli
+
+FastGPT 插件开发的命令行工具，用于创建、构建和测试 FastGPT 工具 / 工具集。
+
+### Features
+
+- **统一构建流程**
+  - 基于 `tsdown`，一键将 TypeScript 源码构建为 Node 22 兼容的 `dist` 产物
+  - 自动生成 d.ts 类型声明，方便在其他包中引用
+- **工具/工具集专用构建**
+  - 支持以工具目录为入口（包含 `config.ts`、`index.ts` 等）
+  - 在临时目录中对 `config.ts` 做 AST 转换，自动注入必要的 `toolId`、版本等元信息
+  - 递归复制源码目录，自动跳过 `node_modules`、`dist`、`.build-*` 等目录
+- **安全的构建行为**
+  - 不在构建过程中调用 `process.exit`，错误以异常抛出，方便在上层脚本中统一处理
+  - 自动创建临时构建目录并在构建结束后进行清理
+- **测试友好**
+  - 内置 Vitest 配置，支持对构建逻辑进行单元测试
+  - 在测试环境下跳过对部分依赖的打包，构建更快更稳定
+
+### 待实现 / TODO
+
+- **发布相关能力（publish）**
+  - 提供 `cli publish` 命令，将构建好的工具包一键发布到 npm 或内部制品库
+  - 支持从 `config.ts` / `package.json` 读取版本号并进行版本校验（防止重复发布）
+  - 集成变更日志（changelog）生成和打 tag 流程
+  - 可选的 dry-run 模式（仅输出将要执行的操作，不真正发布）
+  - 支持自定义 npm registry / token 配置（环境变量或配置文件）
+- **项目脚手架**
+  - 新建单工具模板（含 `config.ts`、`src/index.ts`、测试和示例）
+  - 新建工具集模板（含 children 目录、共享配置示例）
+- **更多开发体验优化**
+  - `watch` 模式：监听源码变化自动重新构建
+  - 输出更友好的构建日志和错误提示
+

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,444 @@
+import path, { join } from "node:path";
+import { consola } from "consola";
+import { Command } from "commander";
+import fs from "node:fs/promises";
+import { input, select } from "@inquirer/prompts";
+import { build } from "tsdown";
+import { parse } from "@babel/parser";
+import * as $traverse from "@babel/traverse";
+import * as $generate from "@babel/generator";
+import { existsSync, readdirSync } from "node:fs";
+
+//#region package.json
+var name = "@fastgpt-plugin/cli";
+var version = "0.1.0";
+
+//#endregion
+//#region src/constants.ts
+const CLI_NAME = name;
+const CLI_VERSION = version;
+const DEFAULT_PLUGIN_NAME = "./packages/my-tool";
+const DEFAULT_PLUGIN_DESCRIPTION = "This is a FastGPT plugin";
+const TOOL_TEMPLATES_DIR = path.join(import.meta.dirname, "../templates");
+
+//#endregion
+//#region src/helpers.ts
+const logger = consola.withTag(CLI_NAME);
+
+//#endregion
+//#region src/commands/base.ts
+/**
+* 所有子命令的基类：
+* - 统一命令接口类型
+* - 强制实现 register 方法，用于向 Commander 注册自身
+*/
+var BaseCommand = class {};
+
+//#endregion
+//#region src/prompts/create/deps.ts
+const defaultDeps = {
+	input,
+	select
+};
+
+//#endregion
+//#region src/prompts/create/input-prompt.ts
+async function inputPrompt(deps, options) {
+	return deps.input({
+		...options,
+		validate: (value) => {
+			if (!value || value.trim().length === 0) return "请输入有效的内容";
+			return true;
+		}
+	});
+}
+
+//#endregion
+//#region src/prompts/create/prompt.ts
+var CreatePrompt = class {
+	deps;
+	constructor(deps = defaultDeps) {
+		this.deps = deps;
+	}
+	/**
+	* 根据 CLI 传入的原始参数，交互式补全缺失字段，生成完整的 CreatePluginCommandOptions。
+	* - 如果 name、type、description 都已提供，则不进入交互流程，直接返回
+	* - 否则使用交互式 prompt 补全缺失部分
+	*/
+	async run(input) {
+		const getPluginType = () => {
+			if (!input.typeFlag) return void 0;
+			return input.typeFlag === "tool-suite" ? "tool-suite" : "tool";
+		};
+		const pluginType = getPluginType();
+		if (input.nameArg && pluginType && input.descriptionFlag !== void 0) return {
+			name: input.nameArg,
+			cwd: input.cwd,
+			type: pluginType,
+			description: input.descriptionFlag
+		};
+		const getPluginNameInputPrompt = async () => {
+			return await inputPrompt(this.deps, {
+				message: "插件名称",
+				default: DEFAULT_PLUGIN_NAME
+			});
+		};
+		const name = input.nameArg ?? await getPluginNameInputPrompt();
+		const getPluginTypeSelectPrompt = async () => {
+			return await this.deps.select({
+				message: "选择插件类型",
+				choices: [{
+					name: "单工具",
+					value: "tool",
+					description: "创建一个独立的工具"
+				}, {
+					name: "工具集",
+					value: "tool-suite",
+					description: "创建一个包含多个子工具的工具集"
+				}]
+			});
+		};
+		const type = pluginType ?? await getPluginTypeSelectPrompt();
+		const getPluginDescriptionInputPrompt = async () => {
+			return await inputPrompt(this.deps, {
+				message: "插件描述",
+				default: DEFAULT_PLUGIN_DESCRIPTION
+			});
+		};
+		const description = input.descriptionFlag ?? await getPluginDescriptionInputPrompt();
+		return {
+			name,
+			cwd: input.cwd,
+			type,
+			description
+		};
+	}
+};
+
+//#endregion
+//#region src/commands/create.ts
+var CreateCommand = class extends BaseCommand {
+	register(parent) {
+		parent.command("create").description("创建新的 FastGPT 插件项目").argument("[name]", "插件名称").option("-t, --type <type>", "插件类型: 单工具 | 工具集").option("-d, --description <desc>", "插件描述").option("--cwd <path>", "工作目录", process.cwd()).action(async (name, opts) => {
+			const options = await new CreatePrompt().run({
+				nameArg: name,
+				typeFlag: opts.type,
+				descriptionFlag: opts.description,
+				cwd: opts.cwd
+			});
+			await this.run(options);
+		});
+	}
+	async run(options) {
+		const targetDir = path.resolve(options.cwd, options.name);
+		const templateDir = path.join(TOOL_TEMPLATES_DIR, options.type === "tool-suite" ? "tool-suite" : "tool");
+		const files = await this.collectTemplateFiles(templateDir);
+		const description = options.description ?? DEFAULT_PLUGIN_DESCRIPTION;
+		await this.ensureDir(targetDir);
+		for (const rel of files) {
+			const templatePath = path.join(templateDir, rel);
+			const filePath = path.join(targetDir, rel);
+			await this.ensureDir(path.dirname(filePath));
+			const raw = await fs.readFile(templatePath, "utf-8");
+			const content = this.applyPlaceholders(raw, options.name, description);
+			await fs.writeFile(filePath, content, "utf-8");
+		}
+		logger.success(`创建插件项目: ${options.name} (${options.type})`, { cwd: options.cwd });
+	}
+	applyPlaceholders(text, name, description) {
+		name = path.basename(name);
+		return text.replace(/\{\{name\}\}/g, name).replace(/\{\{description\}\}/g, description);
+	}
+	async collectTemplateFiles(root) {
+		const result = [];
+		const walk = async (dir) => {
+			const entries = await fs.readdir(dir, { withFileTypes: true });
+			for (const entry of entries) {
+				const full = path.join(dir, entry.name);
+				if (entry.isDirectory()) await walk(full);
+				else {
+					const rel = path.relative(root, full).replace(/\\/g, "/");
+					result.push(rel);
+				}
+			}
+		};
+		await walk(root);
+		return result.sort();
+	}
+	async ensureDir(dir) {
+		await fs.mkdir(dir, { recursive: true });
+	}
+};
+
+//#endregion
+//#region src/build/ast-transform.ts
+const traverse = $traverse.default;
+const generate = $generate.default;
+function extractToolId(filePath) {
+	const stack = filePath.split("/");
+	if (stack.at(-3) === "children") return `${stack.at(-4)}/${stack.at(-2)}`;
+	return stack.at(-2) || "unknown";
+}
+function transformToolConfig({ sourceCode, filePath }) {
+	if (sourceCode.includes("toolId:")) return {
+		code: sourceCode,
+		hasToolId: true
+	};
+	const ast = parse(sourceCode, {
+		plugins: ["typescript"],
+		sourceType: "module"
+	});
+	const toolId = extractToolId(filePath);
+	let modified = false;
+	const childrenDir = join(filePath, "..", "children");
+	let childrenList = [];
+	if (existsSync(childrenDir)) try {
+		childrenList = readdirSync(childrenDir);
+	} catch {}
+	traverse(ast, { CallExpression(path) {
+		if (path.node.callee.type === "Identifier" && path.node.arguments[0] && path.node.arguments[0].type === "ObjectExpression") {
+			const objExpr = path.node.arguments[0];
+			let hasToolId = false;
+			traverse(path.node, { ObjectProperty(innerPath) {
+				if (innerPath.node.key.type === "Identifier" && innerPath.node.key.name === "toolId") hasToolId = true;
+			} }, path.scope, path.parentPath);
+			if (!hasToolId) {
+				const toolIdProp = {
+					type: "ObjectProperty",
+					key: {
+						type: "Identifier",
+						name: "toolId"
+					},
+					value: {
+						type: "StringLiteral",
+						value: toolId
+					},
+					computed: false,
+					shorthand: false
+				};
+				objExpr.properties.push(toolIdProp);
+				modified = true;
+			}
+			if (path.node.callee.type === "Identifier" && path.node.callee.name === "defineToolSet") {
+				let hasCustomChildren = false;
+				traverse(path.node, { ObjectProperty(innerPath) {
+					if (innerPath.node.key.type === "Identifier" && innerPath.node.key.name === "children") hasCustomChildren = true;
+				} }, path.scope, path.parentPath);
+				if (!hasCustomChildren && childrenList.length > 0) {
+					for (const child of childrenList) {
+						const importDecl = {
+							type: "ImportDeclaration",
+							source: {
+								type: "StringLiteral",
+								value: `./children/${child}`
+							},
+							importKind: "value",
+							specifiers: [{
+								type: "ImportDefaultSpecifier",
+								local: {
+									type: "Identifier",
+									name: child
+								}
+							}]
+						};
+						ast.program.body.unshift(importDecl);
+					}
+					const childrenProp = {
+						type: "ObjectProperty",
+						key: {
+							type: "Identifier",
+							name: "children"
+						},
+						value: {
+							type: "ArrayExpression",
+							elements: childrenList.map((child) => ({
+								type: "Identifier",
+								name: child
+							}))
+						},
+						computed: false,
+						shorthand: false
+					};
+					objExpr.properties.push(childrenProp);
+					modified = true;
+				}
+			}
+		}
+	} });
+	return {
+		code: generate(ast).code,
+		hasToolId: !modified && sourceCode.includes("toolId:")
+	};
+}
+
+//#endregion
+//#region src/build/index.ts
+/**
+* 核心构建逻辑：给定入口目录和输出目录，完成一次工具构建。
+* - 不做日志输出
+* - 不调用 process.exit
+* - 失败时抛出 Error
+*/
+async function buildToolPackage(options) {
+	const entryDir = path.resolve(options.entry);
+	await assertPathExists(entryDir, `入口目录不存在: ${entryDir}`);
+	const configPath = path.join(entryDir, "config.ts");
+	await assertPathExists(configPath, `找不到 config.ts 文件: ${configPath}`);
+	const indexPath = path.join(entryDir, "index.ts");
+	await assertPathExists(indexPath, `找不到 index.ts 文件: ${indexPath}`);
+	const tempDir = path.join(entryDir, ".build-temp");
+	await ensureDir(tempDir);
+	try {
+		const transformed = transformToolConfig({
+			sourceCode: await fs.readFile(configPath, "utf-8"),
+			filePath: configPath
+		});
+		await fs.writeFile(path.join(tempDir, "config.ts"), transformed.code, "utf-8");
+		await copySourceFiles(entryDir, tempDir, entryDir);
+		const outputDir = path.resolve(options.output);
+		await ensureDir(outputDir);
+		await build({
+			entry: [path.join(tempDir, "index.ts")],
+			outDir: outputDir,
+			format: [options.format],
+			clean: true,
+			minify: options.minify,
+			platform: "node",
+			target: "node22",
+			dts: {
+				enabled: true,
+				sourcemap: false
+			},
+			treeshake: true,
+			skipNodeModulesBundle: process.env.NODE_ENV === "test",
+			external: process.env.NODE_ENV === "test" ? ["@fastgpt-plugin/helpers"] : []
+		});
+		return {
+			entryDir,
+			outputDir,
+			files: (await fs.readdir(outputDir)).map((f) => f)
+		};
+	} finally {
+		try {
+			await fs.rm(tempDir, {
+				recursive: true,
+				force: true
+			});
+		} catch {}
+	}
+}
+/**
+* 从入口目录复制源码到临时目录：
+* - 根目录的 config.ts 已被转换，不再复制
+* - 子目录中的 config.ts 需要保留（子工具自身的配置）
+*/
+async function copySourceFiles(sourceDir, targetDir, rootDir) {
+	const files = await fs.readdir(sourceDir, { withFileTypes: true });
+	for (const file of files) {
+		if (file.name === "node_modules" || file.name === "dist" || file.name.startsWith(".build-")) continue;
+		const sourcePath = path.join(sourceDir, file.name);
+		const targetPath = path.join(targetDir, file.name);
+		if (file.isDirectory()) {
+			await ensureDir(targetPath);
+			await copySourceFiles(sourcePath, targetPath, rootDir);
+		} else if (file.isFile()) {
+			if (!(file.name === "config.ts" && sourceDir === rootDir)) if (file.name === "config.ts") {
+				const transformed = transformToolConfig({
+					sourceCode: await fs.readFile(sourcePath, "utf-8"),
+					filePath: sourcePath
+				});
+				await fs.writeFile(targetPath, transformed.code, "utf-8");
+			} else await fs.copyFile(sourcePath, targetPath);
+		}
+	}
+}
+async function ensureDir(dir) {
+	await fs.mkdir(dir, { recursive: true });
+}
+async function assertPathExists(p, message) {
+	try {
+		await fs.access(p);
+	} catch {
+		throw new Error(message);
+	}
+}
+
+//#endregion
+//#region src/commands/build.ts
+var BuildCommand = class extends BaseCommand {
+	register(parent) {
+		parent.command("build").description("构建 FastGPT 插件为可分发的包").option("-e, --entry <path>", "工具入口目录", process.cwd()).option("-o, --output <path>", "输出目录", "./dist").option("-m, --minify", "压缩输出代码", false).option("-w, --watch", "监听模式", false).option("-f, --format <format>", "输出格式: esm | cjs", "esm").action(async (opts) => {
+			await this.run({
+				entry: opts.entry,
+				output: opts.output,
+				minify: opts.minify,
+				watch: opts.watch,
+				format: opts.format
+			});
+		});
+	}
+	async run(options) {
+		const start = Date.now();
+		logger.box([
+			"FastGPT 插件构建",
+			"",
+			`入口目录: ${options.entry}`,
+			`输出目录: ${options.output}`,
+			`代码压缩: ${options.minify ? "开启" : "关闭"}`,
+			`输出格式: ${options.format}`,
+			""
+		].join("\n"));
+		logger.start("准备构建插件...");
+		try {
+			const result = await buildToolPackage(options);
+			const duration = ((Date.now() - start) / 1e3).toFixed(2);
+			logger.success(`构建完成，用时 ${duration}s`);
+			logger.info(`输出目录: ${result.outputDir}`);
+			if (result.files.length > 0) {
+				logger.info("生成的文件列表:");
+				result.files.forEach((file) => {
+					logger.info(`  • ${file}`);
+				});
+			} else logger.info("未检测到输出文件，请检查配置。");
+			logger.info("\n下一步: 可以将该目录作为 npm 包发布，或在 FastGPT 中作为插件安装使用。");
+			if (options.watch) logger.info("\n监听模式暂不支持，请使用 --no-watch 选项");
+		} catch (error) {
+			logger.error("构建失败，详情如下:");
+			logger.error(error instanceof Error ? error : new Error(String(error)));
+			logger.info("如果这是在 CI 中发生的，请查看上方构建日志以获取更多信息。");
+			process.exit(1);
+		}
+	}
+};
+
+//#endregion
+//#region src/cmd.ts
+function createProgram() {
+	const program = new Command();
+	program.name(CLI_NAME).version(CLI_VERSION).description("FastGPT 插件开发 CLI");
+	new CreateCommand().register(program);
+	new BuildCommand().register(program);
+	return program;
+}
+/**
+* 运行 CLI，解析 process.argv。
+* @param argv 可选，用于测试时注入参数（如 ['node', 'cli', '--version']）
+*/
+async function run(argv) {
+	await createProgram().parseAsync(argv ?? process.argv);
+}
+
+//#endregion
+//#region src/index.ts
+const main = async () => {
+	try {
+		await run();
+	} catch (error) {
+		logger.error(error);
+		process.exitCode = 1;
+	}
+};
+if (import.meta.main) main();
+
+//#endregion
+export {  };

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@fastgpt-plugin/cli",
+  "version": "0.1.0-alpha.1",
+  "type": "module",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "@fastgpt-plugin/cli": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md",
+    "LICENSE",
+    "package.json"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "start": "bun run src/index.ts",
+    "dev": "bun run src/index.ts"
+  },
+  "dependencies": {
+    "@babel/generator": "^7.26.5",
+    "@babel/parser": "^7.26.5",
+    "@babel/traverse": "^7.26.5",
+    "@babel/types": "^7.26.5",
+    "@inquirer/prompts": "^8.2.0",
+    "commander": "^14.0.3",
+    "consola": "^3.4.2",
+    "tsdown": "^0.20.1"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5",
+    "vite-tsconfig-paths": "^6.0.5",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  }
+}

package/templates/tool/README.md

@@ -0,0 +1,11 @@
+# {{name}}
+
+{{description}}
+
+## 开发
+
+```bash
+bun install
+bun run build
+bun run test
+```

package/templates/tool/config.ts

@@ -0,0 +1,29 @@
+import { defineTool, WorkflowIOValueTypeEnum, ToolTagEnum } from '@fastgpt-plugin/helpers';
+
+export default defineTool({
+  tags: [ToolTagEnum.enum.tools],
+  name: {
+    'zh-CN': '{{name}}',
+    en: '{{name}}'
+  },
+  description: {
+    'zh-CN': '{{description}}',
+    en: '{{description}}'
+  },
+  icon: 'core/workflow/template/{{name}}',
+  versionList: [
+    {
+      value: '0.0.1',
+      description: 'Initial version',
+      inputs: [],
+      outputs: [
+        {
+          key: 'message',
+          valueType: WorkflowIOValueTypeEnum.enum.string,
+          label: 'Message',
+          description: 'Tool output message'
+        }
+      ]
+    }
+  ]
+});

package/templates/tool/index.ts

@@ -0,0 +1,10 @@
+import { exportTool } from '@fastgpt-plugin/helpers/tools/helper';
+import config from './config.js';
+import { InputType, OutputType, tool as toolCb } from './src/tool.js';
+
+export default exportTool({
+  toolCb,
+  InputType,
+  OutputType,
+  config
+});

package/templates/tool/logo.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64">
+  <rect width="64" height="64" rx="8" fill="#e0e7ff" />
+  <text x="32" y="40" text-anchor="middle" font-size="24" fill="#4338ca">?</text>
+</svg>

package/templates/tool/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "{{name}}",
+  "version": "0.0.1",
+  "description": "{{description}}",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@fastgpt-plugin/helpers": "catalog:",
+    "zod": "catalog:"
+  },
+  "devDependencies": {
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  }
+}

package/templates/tool/src/schemas.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+export const InputType = z.object({});
+
+export const OutputType = z.object({
+  message: z.string()
+});
+

package/templates/tool/src/tool.test.ts

@@ -0,0 +1,37 @@
+import { describe, it, expect } from 'vitest';
+import { tool } from './tool';
+import { InputType, OutputType } from './schemas';
+
+describe('{{name}}', () => {
+  it('should run with valid IO schemas', async () => {
+    const input = InputType.parse({});
+    const result = await tool(input, {
+      systemVar: {
+        user: {
+          id: 'test',
+          username: 'test',
+          contact: 'test',
+          membername: 'test',
+          teamName: 'test',
+          teamId: 'test',
+          name: 'test'
+        },
+        app: {
+          id: 'test',
+          name: 'test'
+        },
+        tool: {
+          id: 'test',
+          version: '0.0.1'
+        },
+        time: new Date().toISOString()
+      },
+      streamResponse: () => {
+        // noop
+      }
+    });
+
+    const output = OutputType.parse(result);
+    expect(output).toBeDefined();
+  });
+});

package/templates/tool/src/tool.ts

@@ -0,0 +1,10 @@
+import type { RunToolSecondParamsType } from '@fastgpt-plugin/helpers/tools/schemas/req';
+import type { z } from 'zod';
+import { InputType, OutputType } from './schemas';
+
+export async function tool(
+  _input: z.infer<typeof InputType>,
+  _ctx: RunToolSecondParamsType
+): Promise<z.infer<typeof OutputType>> {
+  return { message: 'Hello from {{name}}' };
+}

package/templates/tool/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'node'
+  }
+});

package/templates/tool-suite/README.md

@@ -0,0 +1,11 @@
+# {{name}}
+
+{{description}}
+
+## 开发
+
+```bash
+bun install
+bun run build
+bun run test
+```

package/templates/tool-suite/children/tool/config.ts

@@ -0,0 +1,29 @@
+import { defineTool, WorkflowIOValueTypeEnum, ToolTagEnum } from '@fastgpt-plugin/helpers';
+
+export default defineTool({
+  tags: [ToolTagEnum.enum.tools],
+  name: {
+    'zh-CN': '{{name}}',
+    en: '{{name}}'
+  },
+  description: {
+    'zh-CN': '{{description}}',
+    en: '{{description}}'
+  },
+  icon: 'core/workflow/template/{{name}}',
+  versionList: [
+    {
+      value: '0.0.1',
+      description: 'Initial version',
+      inputs: [],
+      outputs: [
+        {
+          key: 'message',
+          valueType: WorkflowIOValueTypeEnum.enum.string,
+          label: 'Message',
+          description: 'Tool output message'
+        }
+      ]
+    }
+  ]
+});

package/templates/tool-suite/children/tool/index.ts

@@ -0,0 +1,10 @@
+import { exportTool } from '@fastgpt-plugin/helpers/tools/helper';
+import config from './config.js';
+import { InputType, OutputType, tool as toolCb } from './src/tool.js';
+
+export default exportTool({
+  toolCb,
+  InputType,
+  OutputType,
+  config
+});

package/templates/tool-suite/children/tool/logo.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64">
+  <rect width="64" height="64" rx="8" fill="#e0e7ff" />
+  <text x="32" y="40" text-anchor="middle" font-size="24" fill="#4338ca">?</text>
+</svg>

package/templates/tool-suite/children/tool/src/schemas.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+export const InputType = z.object({});
+
+export const OutputType = z.object({
+  message: z.string()
+});
+

package/templates/tool-suite/children/tool/src/tool.test.ts

@@ -0,0 +1,37 @@
+import { describe, it, expect } from 'vitest';
+import { tool } from './tool';
+import { InputType, OutputType } from './schemas';
+
+describe('{{name}} child tool', () => {
+  it('should run with valid IO schemas', async () => {
+    const input = InputType.parse({});
+    const result = await tool(input, {
+      systemVar: {
+        user: {
+          id: 'test',
+          username: 'test',
+          contact: 'test',
+          membername: 'test',
+          teamName: 'test',
+          teamId: 'test',
+          name: 'test'
+        },
+        app: {
+          id: 'test',
+          name: 'test'
+        },
+        tool: {
+          id: 'test',
+          version: '0.0.1'
+        },
+        time: new Date().toISOString()
+      },
+      streamResponse: () => {
+        // noop
+      }
+    });
+
+    const output = OutputType.parse(result);
+    expect(output).toBeDefined();
+  });
+});

package/templates/tool-suite/children/tool/src/tool.ts

@@ -0,0 +1,10 @@
+import type { RunToolSecondParamsType } from '@fastgpt-plugin/helpers/tools/schemas/req';
+import type { z } from 'zod';
+import { InputType, OutputType } from './schemas';
+
+export async function tool(
+  _input: z.infer<typeof InputType>,
+  _ctx: RunToolSecondParamsType
+): Promise<z.infer<typeof OutputType>> {
+  return { message: 'Hello from {{name}}' };
+}

package/templates/tool-suite/config.ts

@@ -0,0 +1,13 @@
+import { defineToolSet, ToolTagEnum } from '@fastgpt-plugin/helpers';
+
+export default defineToolSet({
+  tags: [ToolTagEnum.enum.tools],
+  name: {
+    'zh-CN': '{{name}}',
+    en: '{{name}}'
+  },
+  description: {
+    'zh-CN': '{{description}}',
+    en: '{{description}}'
+  }
+});

package/templates/tool-suite/index.ts

@@ -0,0 +1,2 @@
+export { default as config } from './config.js';
+export { tool as toolFromChild } from './children/tool/src/index.js';

package/templates/tool-suite/logo.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64">
+  <rect width="64" height="64" rx="8" fill="#e0e7ff" />
+  <text x="32" y="40" text-anchor="middle" font-size="24" fill="#4338ca">?</text>
+</svg>

package/templates/tool-suite/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "{{name}}",
+  "version": "0.0.1",
+  "description": "{{description}}",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@fastgpt-plugin/helpers": "catalog:",
+    "zod": "catalog:"
+  },
+  "devDependencies": {
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  }
+}

package/templates/tool-suite/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'node'
+  }
+});
+