@agiflowai/scaffold-mcp 1.0.6 → 1.0.8

package/dist/ListScaffoldingMethodsTool-BLTCwsd1.mjs

@@ -0,0 +1,350 @@
+import { t as TemplateService } from "./TemplateService-CVDL2uqt.mjs";
+import path from "node:path";
+import { ProjectConfigResolver, copy, ensureDir, log, pathExists, readFile, readJson, readdir, stat, writeFile } from "@agiflowai/aicode-utils";
+import yaml from "js-yaml";
+
+//#region src/utils/pagination.ts
+var PaginationHelper = class PaginationHelper {
+	/**
+	* Default page size for pagination
+	*/
+	static DEFAULT_PAGE_SIZE = 10;
+	/**
+	* Decodes a cursor string to extract the start index
+	* @param cursor - String representing the start index (e.g., "10")
+	* @returns Start index or 0 if invalid/undefined
+	*/
+	static decodeCursor(cursor) {
+		if (!cursor) return 0;
+		const index = Number.parseInt(cursor, 10);
+		if (Number.isNaN(index) || index < 0) return 0;
+		return index;
+	}
+	/**
+	* Encodes an index into a cursor string
+	* @param index - Start index to encode
+	* @returns Cursor string (e.g., "10")
+	*/
+	static encodeCursor(index) {
+		return index.toString();
+	}
+	/**
+	* Paginates an array of items
+	* @param items - All items to paginate
+	* @param cursor - Optional cursor representing the start index
+	* @param pageSize - Number of items per page (default: 10)
+	* @param includeMeta - Whether to include metadata in response (default: true)
+	* @returns Paginated result with items and optional nextCursor
+	*/
+	static paginate(items, cursor, pageSize = PaginationHelper.DEFAULT_PAGE_SIZE, includeMeta = true) {
+		const startIndex = PaginationHelper.decodeCursor(cursor);
+		const endIndex = startIndex + pageSize;
+		const result = {
+			items: items.slice(startIndex, endIndex),
+			nextCursor: endIndex < items.length ? PaginationHelper.encodeCursor(endIndex) : void 0
+		};
+		if (includeMeta) result._meta = {
+			total: items.length,
+			offset: startIndex,
+			limit: pageSize
+		};
+		return result;
+	}
+};
+
+//#endregion
+//#region src/services/FileSystemService.ts
+var FileSystemService = class {
+	async pathExists(path$1) {
+		return pathExists(path$1);
+	}
+	async readFile(path$1, encoding = "utf8") {
+		return readFile(path$1, encoding);
+	}
+	async readJson(path$1) {
+		return readJson(path$1);
+	}
+	async writeFile(path$1, content, encoding = "utf8") {
+		return writeFile(path$1, content, encoding);
+	}
+	async ensureDir(path$1) {
+		return ensureDir(path$1);
+	}
+	async copy(src, dest) {
+		return copy(src, dest);
+	}
+	async readdir(path$1) {
+		return readdir(path$1);
+	}
+	async stat(path$1) {
+		return stat(path$1);
+	}
+};
+
+//#endregion
+//#region src/services/ScaffoldingMethodsService.ts
+var ScaffoldingMethodsService = class {
+	templateService;
+	constructor(fileSystem, templatesRootPath) {
+		this.fileSystem = fileSystem;
+		this.templatesRootPath = templatesRootPath;
+		this.templateService = new TemplateService();
+	}
+	async listScaffoldingMethods(projectPath, cursor) {
+		const absoluteProjectPath = path.resolve(projectPath);
+		const sourceTemplate = (await ProjectConfigResolver.resolveProjectConfig(absoluteProjectPath)).sourceTemplate;
+		return this.listScaffoldingMethodsByTemplate(sourceTemplate, cursor);
+	}
+	async listScaffoldingMethodsByTemplate(templateName, cursor) {
+		const templatePath = await this.findTemplatePath(templateName);
+		if (!templatePath) throw new Error(`Template not found for sourceTemplate: ${templateName}`);
+		const fullTemplatePath = path.join(this.templatesRootPath, templatePath);
+		const scaffoldYamlPath = path.join(fullTemplatePath, "scaffold.yaml");
+		if (!await this.fileSystem.pathExists(scaffoldYamlPath)) throw new Error(`scaffold.yaml not found at ${scaffoldYamlPath}`);
+		const scaffoldContent = await this.fileSystem.readFile(scaffoldYamlPath, "utf8");
+		const architectConfig = yaml.load(scaffoldContent);
+		const methods = [];
+		if (architectConfig.features && Array.isArray(architectConfig.features)) architectConfig.features.forEach((feature) => {
+			const featureName = feature.name || `scaffold-${templateName}`;
+			methods.push({
+				name: featureName,
+				description: feature.description || "",
+				instruction: feature.instruction || "",
+				variables_schema: feature.variables_schema || {
+					type: "object",
+					properties: {},
+					required: [],
+					additionalProperties: false
+				},
+				generator: feature.generator
+			});
+		});
+		const paginatedResult = PaginationHelper.paginate(methods, cursor);
+		return {
+			sourceTemplate: templateName,
+			templatePath,
+			methods: paginatedResult.items,
+			nextCursor: paginatedResult.nextCursor,
+			_meta: paginatedResult._meta
+		};
+	}
+	/**
+	* Gets scaffolding methods with instructions rendered using provided variables
+	*/
+	async listScaffoldingMethodsWithVariables(projectPath, variables, cursor) {
+		const result = await this.listScaffoldingMethods(projectPath, cursor);
+		const processedMethods = result.methods.map((method) => ({
+			...method,
+			instruction: method.instruction ? this.processScaffoldInstruction(method.instruction, variables) : void 0
+		}));
+		return {
+			...result,
+			methods: processedMethods
+		};
+	}
+	/**
+	* Processes scaffold instruction with template service
+	*/
+	processScaffoldInstruction(instruction, variables) {
+		if (this.templateService.containsTemplateVariables(instruction)) return this.templateService.renderString(instruction, variables);
+		return instruction;
+	}
+	async findTemplatePath(sourceTemplate) {
+		const templateDirs = await this.discoverTemplateDirs();
+		if (templateDirs.includes(sourceTemplate)) return sourceTemplate;
+		for (const templateDir of templateDirs) {
+			const templatePath = path.join(this.templatesRootPath, templateDir);
+			const scaffoldYamlPath = path.join(templatePath, "scaffold.yaml");
+			if (await this.fileSystem.pathExists(scaffoldYamlPath)) try {
+				const scaffoldContent = await this.fileSystem.readFile(scaffoldYamlPath, "utf8");
+				const architectConfig = yaml.load(scaffoldContent);
+				if (architectConfig.boilerplate && Array.isArray(architectConfig.boilerplate)) {
+					for (const boilerplate of architectConfig.boilerplate) if (boilerplate.name?.includes(sourceTemplate)) return templateDir;
+				}
+			} catch (error) {
+				log.warn(`Failed to read scaffold.yaml at ${scaffoldYamlPath}:`, error);
+			}
+		}
+		return null;
+	}
+	/**
+	* Resolves the project path, handling both monorepo and monolith cases
+	* Uses ProjectConfigResolver to find the correct workspace/project root
+	*/
+	async resolveProjectPath(projectPath) {
+		const absolutePath = path.resolve(projectPath);
+		return (await ProjectConfigResolver.resolveProjectConfig(absolutePath)).workspaceRoot || absolutePath;
+	}
+	/**
+	* Dynamically discovers all template directories
+	* Supports both flat structure (templates/nextjs-15) and nested structure (templates/apps/nextjs-15)
+	**/
+	async discoverTemplateDirs() {
+		const templateDirs = [];
+		try {
+			const items = await this.fileSystem.readdir(this.templatesRootPath);
+			for (const item of items) {
+				const itemPath = path.join(this.templatesRootPath, item);
+				if (!(await this.fileSystem.stat(itemPath)).isDirectory()) continue;
+				const scaffoldYamlPath = path.join(itemPath, "scaffold.yaml");
+				if (await this.fileSystem.pathExists(scaffoldYamlPath)) {
+					templateDirs.push(item);
+					continue;
+				}
+				try {
+					const subItems = await this.fileSystem.readdir(itemPath);
+					for (const subItem of subItems) {
+						const subItemPath = path.join(itemPath, subItem);
+						if (!(await this.fileSystem.stat(subItemPath)).isDirectory()) continue;
+						const subScaffoldYamlPath = path.join(subItemPath, "scaffold.yaml");
+						if (await this.fileSystem.pathExists(subScaffoldYamlPath)) {
+							const relativePath = path.join(item, subItem);
+							templateDirs.push(relativePath);
+						}
+					}
+				} catch (error) {
+					log.warn(`Failed to read subdirectories in ${itemPath}:`, error);
+				}
+			}
+		} catch (error) {
+			log.warn(`Failed to read templates root directory ${this.templatesRootPath}:`, error);
+		}
+		return templateDirs;
+	}
+	async useScaffoldMethod(request) {
+		const { projectPath, scaffold_feature_name, variables, sessionId } = request;
+		const absoluteProjectPath = await this.resolveProjectPath(projectPath);
+		const scaffoldingMethods = await this.listScaffoldingMethods(absoluteProjectPath);
+		const method = scaffoldingMethods.methods.find((m) => m.name === scaffold_feature_name);
+		if (!method) {
+			const availableMethods = scaffoldingMethods.methods.map((m) => m.name).join(", ");
+			throw new Error(`Scaffold method '${scaffold_feature_name}' not found. Available methods: ${availableMethods}`);
+		}
+		const ScaffoldService = (await import("./ScaffoldService-BCjJE9yK.mjs")).ScaffoldService;
+		const ScaffoldConfigLoader = (await import("./ScaffoldConfigLoader-DKJtnrWT.mjs")).ScaffoldConfigLoader;
+		const VariableReplacementService = (await import("./VariableReplacementService-BO-UYgcf.mjs")).VariableReplacementService;
+		const TemplateService$1 = (await import("./TemplateService-B1bd6iHw.mjs")).TemplateService;
+		const templateService = new TemplateService$1();
+		const scaffoldConfigLoader = new ScaffoldConfigLoader(this.fileSystem, templateService);
+		const variableReplacer = new VariableReplacementService(this.fileSystem, templateService);
+		const scaffoldService = new ScaffoldService(this.fileSystem, scaffoldConfigLoader, variableReplacer, this.templatesRootPath);
+		const projectName = path.basename(absoluteProjectPath);
+		const result = await scaffoldService.useFeature({
+			projectPath: absoluteProjectPath,
+			templateFolder: scaffoldingMethods.templatePath,
+			featureName: scaffold_feature_name,
+			variables: {
+				...variables,
+				appPath: absoluteProjectPath,
+				appName: projectName
+			}
+		});
+		if (!result.success) throw new Error(result.message);
+		if (sessionId && result.createdFiles && result.createdFiles.length > 0) try {
+			const { ExecutionLogService, DECISION_ALLOW } = await import("@agiflowai/hooks-adapter");
+			await new ExecutionLogService(sessionId).logExecution({
+				filePath: absoluteProjectPath,
+				operation: "scaffold",
+				decision: DECISION_ALLOW,
+				generatedFiles: result.createdFiles
+			});
+		} catch (error) {
+			log.warn("Failed to log scaffold execution:", error);
+		}
+		return {
+			success: true,
+			message: `
+Successfully scaffolded ${scaffold_feature_name} in ${projectPath}.
+Please follow this **instruction**: \n ${method.instruction ? this.processScaffoldInstruction(method.instruction, variables) : ""}.
+-> Create or update the plan based on the instruction.
+`,
+			warnings: result.warnings,
+			createdFiles: result.createdFiles,
+			existingFiles: result.existingFiles
+		};
+	}
+};
+
+//#endregion
+//#region src/instructions/tools/list-scaffolding-methods/description.md?raw
+var description_default = "Lists all available scaffolding methods (features) that can be added to an existing project{% if not isMonolith %} or for a specific template{% endif %}.\n\nThis tool:\n{% if isMonolith %}\n- Reads your project's sourceTemplate from toolkit.yaml at workspace root\n{% else %}\n- Reads the project's sourceTemplate from project.json (monorepo) or toolkit.yaml (monolith), OR\n- Directly uses the provided templateName to list available features\n{% endif %}\n- Returns available features for that template type\n- Provides variable schemas for each scaffolding method\n- Shows descriptions of what each method creates\n\nUse this FIRST when adding features to understand:\n- What scaffolding methods are available\n- What variables each method requires\n- What files/features will be generated\n\nExample methods might include:\n- Adding new React routes (for React apps)\n- Creating API endpoints (for backend projects)\n- Adding new components (for frontend projects)\n- Setting up database models (for API projects)\n";
+
+//#endregion
+//#region src/tools/ListScaffoldingMethodsTool.ts
+var ListScaffoldingMethodsTool = class ListScaffoldingMethodsTool {
+	static TOOL_NAME = "list-scaffolding-methods";
+	fileSystemService;
+	scaffoldingMethodsService;
+	templateService;
+	isMonolith;
+	constructor(templatesPath, isMonolith = false) {
+		this.fileSystemService = new FileSystemService();
+		this.scaffoldingMethodsService = new ScaffoldingMethodsService(this.fileSystemService, templatesPath);
+		this.templateService = new TemplateService();
+		this.isMonolith = isMonolith;
+	}
+	/**
+	* Get the tool definition for MCP
+	*/
+	getDefinition() {
+		const description = this.templateService.renderString(description_default, { isMonolith: this.isMonolith });
+		const properties = { cursor: {
+			type: "string",
+			description: "Optional pagination cursor to fetch the next page of results. Omit to fetch the first page."
+		} };
+		if (!this.isMonolith) {
+			properties.projectPath = {
+				type: "string",
+				description: "Absolute path to the project directory (for monorepo: containing project.json; for monolith: workspace root with toolkit.yaml). Either projectPath or templateName is required."
+			};
+			properties.templateName = {
+				type: "string",
+				description: "Name of the template to list scaffolding methods for (e.g., \"nextjs-15\", \"typescript-mcp-package\"). Either projectPath or templateName is required."
+			};
+		}
+		return {
+			name: ListScaffoldingMethodsTool.TOOL_NAME,
+			description: description.trim(),
+			inputSchema: {
+				type: "object",
+				properties,
+				additionalProperties: false
+			}
+		};
+	}
+	/**
+	* Execute the tool
+	*/
+	async execute(args) {
+		try {
+			const { projectPath, templateName, cursor } = args;
+			let result;
+			if (this.isMonolith) try {
+				const resolvedTemplateName = (await ProjectConfigResolver.resolveProjectConfig(process.cwd())).sourceTemplate;
+				result = await this.scaffoldingMethodsService.listScaffoldingMethodsByTemplate(resolvedTemplateName, cursor);
+			} catch (error) {
+				throw new Error(`Failed to read template name from configuration: ${error instanceof Error ? error.message : String(error)}`);
+			}
+			else {
+				if (!projectPath && !templateName) throw new Error("Either projectPath or templateName must be provided");
+				if (projectPath) result = await this.scaffoldingMethodsService.listScaffoldingMethods(projectPath, cursor);
+				else result = await this.scaffoldingMethodsService.listScaffoldingMethodsByTemplate(templateName, cursor);
+			}
+			return { content: [{
+				type: "text",
+				text: JSON.stringify(result, null, 2)
+			}] };
+		} catch (error) {
+			return {
+				content: [{
+					type: "text",
+					text: `Error listing scaffolding methods: ${error instanceof Error ? error.message : String(error)}`
+				}],
+				isError: true
+			};
+		}
+	}
+};
+
+//#endregion
+export { PaginationHelper as i, ScaffoldingMethodsService as n, FileSystemService as r, ListScaffoldingMethodsTool as t };