@chrrxs/robloxstudio-mcp 2.23.1 → 3.0.0

package/studio-plugin/src/modules/handlers/QueryHandlers.ts

@@ -123,47 +123,6 @@ function getPlaceInfo(_requestData: Record<string, unknown>) {
 	};
 }
 
-function getServices(requestData: Record<string, unknown>) {
-	const serviceName = requestData.serviceName as string | undefined;
-
-	if (serviceName) {
-		const [ok, service] = pcall(() => game.GetService(serviceName as keyof Services));
-		if (ok && service) {
-			return {
-				service: {
-					name: service.Name,
-					className: service.ClassName,
-					path: getInstancePath(service as Instance),
-					childCount: (service as Instance).GetChildren().size(),
-				},
-			};
-		} else {
-			return { error: `Service not found: ${serviceName}` };
-		}
-	} else {
-		const services: { name: string; className: string; path: string; childCount: number }[] = [];
-		const commonServices = [
-			"Workspace", "Players", "StarterGui", "StarterPack", "StarterPlayer",
-			"ReplicatedStorage", "ServerStorage", "ServerScriptService",
-			"HttpService", "TeleportService", "DataStoreService",
-		];
-
-		for (const svcName of commonServices) {
-			const [ok, service] = pcall(() => game.GetService(svcName as keyof Services));
-			if (ok && service) {
-				services.push({
-					name: service.Name,
-					className: service.ClassName,
-					path: getInstancePath(service as Instance),
-					childCount: (service as Instance).GetChildren().size(),
-				});
-			}
-		}
-
-		return { services };
-	}
-}
-
 function searchObjects(requestData: Record<string, unknown>) {
 	const query = requestData.query as string;
 	const searchType = (requestData.searchType as string) ?? "name";
@@ -316,31 +275,6 @@ function getInstanceProperties(requestData: Record<string, unknown>) {
 	}
 }
 
-function getInstanceChildren(requestData: Record<string, unknown>) {
-	const instancePath = requestData.instancePath as string;
-	if (!instancePath) return { error: "Instance path is required" };
-
-	const instance = getInstanceByPath(instancePath);
-	if (!instance) return { error: `Instance not found: ${instancePath}` };
-
-	const children: { name: string; className: string; path: string; hasChildren: boolean; hasSource: boolean; enabled?: boolean }[] = [];
-	for (const child of instance.GetChildren()) {
-		const entry: { name: string; className: string; path: string; hasChildren: boolean; hasSource: boolean; enabled?: boolean } = {
-			name: child.Name,
-			className: child.ClassName,
-			path: getInstancePath(child),
-			hasChildren: child.GetChildren().size() > 0,
-			hasSource: child.IsA("LuaSourceContainer"),
-		};
-		if (child.IsA("BaseScript")) {
-			entry.enabled = child.Enabled;
-		}
-		children.push(entry);
-	}
-
-	return { instancePath, children, count: children.size() };
-}
-
 function searchByProperty(requestData: Record<string, unknown>) {
 	const propertyName = requestData.propertyName as string;
 	const propertyValue = requestData.propertyValue as string;
@@ -769,106 +703,14 @@ function grepScripts(requestData: Record<string, unknown>) {
 	};
 }
 
-function getDescendants(requestData: Record<string, unknown>) {
-	const instancePath = requestData.instancePath as string;
-	if (!instancePath) return { error: "Instance path is required" };
-
-	const maxDepth = (requestData.maxDepth as number) ?? 10;
-	const classFilter = requestData.classFilter as string | undefined;
-
-	const instance = getInstanceByPath(instancePath);
-	if (!instance) return { error: `Instance not found: ${instancePath}` };
-
-	const descendants: { name: string; className: string; path: string; depth: number }[] = [];
-
-	function collect(inst: Instance, depth: number) {
-		if (depth > maxDepth) return;
-		for (const child of inst.GetChildren()) {
-			if (classFilter && !child.IsA(classFilter as keyof Instances)) continue;
-			descendants.push({
-				name: child.Name,
-				className: child.ClassName,
-				path: getInstancePath(child),
-				depth,
-			});
-			collect(child, depth + 1);
-		}
-	}
-
-	collect(instance, 1);
-
-	return { instancePath, descendants, count: descendants.size(), maxDepth };
-}
-
-function compareInstances(requestData: Record<string, unknown>) {
-	const instancePathA = requestData.instancePathA as string;
-	const instancePathB = requestData.instancePathB as string;
-
-	if (!instancePathA || !instancePathB) {
-		return { error: "Both instancePathA and instancePathB are required" };
-	}
-
-	const instA = getInstanceByPath(instancePathA);
-	if (!instA) return { error: `Instance not found: ${instancePathA}` };
-
-	const instB = getInstanceByPath(instancePathB);
-	if (!instB) return { error: `Instance not found: ${instancePathB}` };
-
-	const commonProps = [
-		"Name", "ClassName",
-		"Size", "Position", "Rotation", "CFrame", "Anchored", "CanCollide",
-		"Transparency", "BrickColor", "Material", "Color", "Text", "TextColor3",
-		"BackgroundColor3", "Image", "ImageColor3", "Visible", "Active", "ZIndex",
-		"BorderSizePixel", "BackgroundTransparency", "ImageTransparency",
-		"TextTransparency", "Value", "Enabled", "Brightness", "Range", "Shadows",
-	];
-
-	const matching: Record<string, string> = {};
-	const differing: Record<string, { a: string; b: string }> = {};
-	const onlyA: string[] = [];
-	const onlyB: string[] = [];
-
-	for (const prop of commonProps) {
-		const [okA, valA] = pcall(() => tostring((instA as unknown as Record<string, unknown>)[prop]));
-		const [okB, valB] = pcall(() => tostring((instB as unknown as Record<string, unknown>)[prop]));
-
-		if (okA && okB) {
-			if (valA === valB) {
-				matching[prop] = valA as string;
-			} else {
-				differing[prop] = { a: valA as string, b: valB as string };
-			}
-		} else if (okA) {
-			onlyA.push(prop);
-		} else if (okB) {
-			onlyB.push(prop);
-		}
-	}
-
-	return {
-		instancePathA,
-		instancePathB,
-		classNameA: instA.ClassName,
-		classNameB: instB.ClassName,
-		matching,
-		differing,
-		onlyA,
-		onlyB,
-	};
-}
-
 export = {
-	getFileTree,
-	searchFiles,
-	getPlaceInfo,
-	getServices,
-	searchObjects,
-	getInstanceProperties,
-	getInstanceChildren,
-	searchByProperty,
-	getClassInfo,
-	getProjectStructure,
-	grepScripts,
-	getDescendants,
-	compareInstances,
+    getFileTree,
+    searchFiles,
+    getPlaceInfo,
+    searchObjects,
+    getInstanceProperties,
+    searchByProperty,
+    getClassInfo,
+    getProjectStructure,
+    grepScripts,
 };

package/studio-plugin/src/modules/handlers/ScriptHandlers.ts

@@ -1,9 +1,7 @@
 import Utils from "../Utils";
 import Recording from "../Recording";
 
-const ScriptEditorService = game.GetService("ScriptEditorService");
-
-const { getInstancePath, getInstanceByPath, readScriptSource, splitLines, joinLines } = Utils;
+const { getInstancePath, getInstanceByPath, readScriptSource, applyScriptSource, splitLines, joinLines } = Utils;
 const { beginRecording, finishRecording } = Recording;
 
 const SOURCE_TRUNCATE_CHAR_BUDGET = 25000;
@@ -125,42 +123,22 @@ function setScriptSource(requestData: Record<string, unknown>) {
 	const sourceToSet = normalizeEscapes(newSource);
 	const recordingId = beginRecording(`Set script source: ${instance.Name}`);
 
-	const [updateSuccess, updateResult] = pcall(() => {
-		const oldSourceLength = readScriptSource(instance).size();
-
-		ScriptEditorService.UpdateSourceAsync(instance, () => sourceToSet);
-		if (readScriptSource(instance) !== sourceToSet) {
-			error("UpdateSourceAsync completed without updating the script source");
-		}
-
-		return {
-			success: true, instancePath,
-			oldSourceLength, newSourceLength: sourceToSet.size(),
-			method: "UpdateSourceAsync",
-			message: "Script source updated successfully (editor-safe)",
-		};
-	});
-
-	if (updateSuccess) {
-		finishRecording(recordingId, true);
-		return updateResult;
+	const [readSuccess, readResult] = pcall(() => readScriptSource(instance).size());
+	if (!readSuccess) {
+		finishRecording(recordingId, false);
+		return { error: `Failed to read script source before updating: ${readResult}` };
 	}
+	const oldSourceLength = readResult as number;
+	const applyResult = applyScriptSource(instance, sourceToSet);
 
-	const [directSuccess, directResult] = pcall(() => {
-		const oldSource = (instance as unknown as { Source: string }).Source;
-		(instance as unknown as { Source: string }).Source = sourceToSet;
-
+	if (applyResult.success) {
+		finishRecording(recordingId, true);
 		return {
 			success: true, instancePath,
-			oldSourceLength: oldSource.size(), newSourceLength: sourceToSet.size(),
-			method: "direct",
-			message: "Script source updated successfully (direct assignment)",
+			oldSourceLength, newSourceLength: sourceToSet.size(),
+			method: applyResult.method,
+			message: `Script source updated successfully (${applyResult.method === "UpdateSourceAsync" ? "editor-safe" : "direct assignment"})`,
 		};
-	});
-
-	if (directSuccess) {
-		finishRecording(recordingId, true);
-		return directResult;
 	}
 
 	const [replaceSuccess, replaceResult] = pcall(() => {
@@ -172,9 +150,15 @@ function setScriptSource(requestData: Record<string, unknown>) {
 
 		const newScript = new Instance(className as keyof CreatableInstances) as LuaSourceContainer;
 		newScript.Name = name;
-		(newScript as unknown as { Source: string }).Source = sourceToSet;
+		// @rbxts/types does not expose PluginSecurity Source writes.
+		const writableNewScript = newScript as unknown as { Source: string };
+		writableNewScript.Source = sourceToSet;
+		if (readScriptSource(newScript) !== sourceToSet) {
+			error("Replacement script source did not match the requested source");
+		}
 		if (wasBaseScript && enabled !== undefined) {
-			(newScript as BaseScript).Enabled = enabled;
+			const newBaseScript = newScript as BaseScript;
+			newBaseScript.Enabled = enabled;
 		}
 
 		newScript.Parent = parent;
@@ -195,7 +179,7 @@ function setScriptSource(requestData: Record<string, unknown>) {
 
 	finishRecording(recordingId, false);
 	return {
-		error: `Failed to set script source. UpdateSourceAsync failed: ${updateResult}. Direct assignment failed: ${directResult}. Replace method failed: ${replaceResult}`,
+		error: `Failed to set script source. ${applyResult.error} Replace method failed: ${replaceResult}`,
 	};
 }
 
@@ -264,11 +248,13 @@ function editScriptLines(requestData: Record<string, unknown>) {
 		// Byte-slice replacement avoids Lua pattern escaping (safe for multi-byte chars like em dashes).
 		const newSource = string.sub(source, 1, matchStart - 1) + newString + string.sub(source, matchStart + searchLen);
 
-		ScriptEditorService.UpdateSourceAsync(instance, () => newSource);
+		const applyResult = applyScriptSource(instance, newSource, source);
+		if (!applyResult.success) error(applyResult.error);
 
 		return {
 			success: true,
 			instancePath,
+			method: applyResult.method,
 			message: "Script edited successfully",
 		};
 	});
@@ -299,7 +285,8 @@ function insertScriptLines(requestData: Record<string, unknown>) {
 	const recordingId = beginRecording(`Insert script lines after line ${afterLine}: ${instance.Name}`);
 
 	const [success, result] = pcall(() => {
-		const [lines, hadTrailingNewline] = splitLines(readScriptSource(instance));
+		const source = readScriptSource(instance);
+		const [lines, hadTrailingNewline] = splitLines(source);
 		const totalLines = lines.size();
 
 		if (afterLine < 0 || afterLine > totalLines) error(`afterLine out of range (0-${totalLines})`);
@@ -312,13 +299,15 @@ function insertScriptLines(requestData: Record<string, unknown>) {
 		for (let i = afterLine; i < totalLines; i++) resultLines.push(lines[i]);
 
 		const newSource = joinLines(resultLines, hadTrailingNewline);
-		ScriptEditorService.UpdateSourceAsync(instance, () => newSource);
+		const applyResult = applyScriptSource(instance, newSource, source);
+		if (!applyResult.success) error(applyResult.error);
 
 		return {
 			success: true, instancePath,
 			insertedAfterLine: afterLine,
 			linesInserted: newLines.size(),
 			newLineCount: resultLines.size(),
+			method: applyResult.method,
 			message: "Script lines inserted successfully",
 		};
 	});
@@ -349,7 +338,8 @@ function deleteScriptLines(requestData: Record<string, unknown>) {
 	const recordingId = beginRecording(`Delete script lines ${startLine}-${endLine}: ${instance.Name}`);
 
 	const [success, result] = pcall(() => {
-		const [lines, hadTrailingNewline] = splitLines(readScriptSource(instance));
+		const source = readScriptSource(instance);
+		const [lines, hadTrailingNewline] = splitLines(source);
 		const totalLines = lines.size();
 
 		if (startLine < 1 || startLine > totalLines) error(`startLine out of range (1-${totalLines})`);
@@ -360,13 +350,15 @@ function deleteScriptLines(requestData: Record<string, unknown>) {
 		for (let i = endLine; i < totalLines; i++) resultLines.push(lines[i]);
 
 		const newSource = joinLines(resultLines, hadTrailingNewline);
-		ScriptEditorService.UpdateSourceAsync(instance, () => newSource);
+		const applyResult = applyScriptSource(instance, newSource, source);
+		if (!applyResult.success) error(applyResult.error);
 
 		return {
 			success: true, instancePath,
 			deletedLines: { startLine, endLine },
 			linesDeleted: endLine - startLine + 1,
 			newLineCount: resultLines.size(),
+			method: applyResult.method,
 			message: "Script lines deleted successfully",
 		};
 	});
@@ -435,6 +427,7 @@ function findAndReplaceInScripts(requestData: Record<string, unknown>) {
 		name: string;
 		className: string;
 		replacements: number;
+		error?: string;
 	}
 
 	const changes: ScriptChange[] = [];
@@ -447,9 +440,9 @@ function findAndReplaceInScripts(requestData: Record<string, unknown>) {
 	function processInstance(instance: Instance) {
 		if (hitLimit) return;
 
-		if (instance.IsA("LuaSourceContainer")) {
-			if (classFilter && !instance.ClassName.lower().find(classFilter.lower())[0]) return;
-
+		const matchesClass = classFilter === undefined
+			|| instance.ClassName.lower().find(classFilter.lower())[0] !== undefined;
+		if (instance.IsA("LuaSourceContainer") && matchesClass) {
 			scriptsSearched++;
 			const source = readScriptSource(instance);
 
@@ -475,23 +468,27 @@ function findAndReplaceInScripts(requestData: Record<string, unknown>) {
 					hitLimit = true;
 					return;
 				}
-				totalReplacements += replCount;
 
-				if (!dryRun) {
-					const [ok] = pcall(() => {
-						ScriptEditorService.UpdateSourceAsync(instance, () => newSource);
+				const applyResult = dryRun
+					? undefined
+					: applyScriptSource(instance, newSource, source);
+				if (applyResult !== undefined && !applyResult.success) {
+					changes.push({
+						instancePath: getInstancePath(instance),
+						name: instance.Name,
+						className: instance.ClassName,
+						replacements: 0,
+						error: applyResult.error ?? "Script write failed verification",
+					});
+				} else {
+					totalReplacements += replCount;
+					changes.push({
+						instancePath: getInstancePath(instance),
+						name: instance.Name,
+						className: instance.ClassName,
+						replacements: replCount,
 					});
-					if (!ok) {
-						(instance as unknown as { Source: string }).Source = newSource;
-					}
 				}
-
-				changes.push({
-					instancePath: getInstancePath(instance),
-					name: instance.Name,
-					className: instance.ClassName,
-					replacements: replCount,
-				});
 			}
 		}
 
@@ -501,20 +498,24 @@ function findAndReplaceInScripts(requestData: Record<string, unknown>) {
 		}
 	}
 
-	processInstance(startInstance);
+	const [traversalSuccess, traversalResult] = pcall(() => processInstance(startInstance));
 
+	const failedScripts = changes.filter((change) => change.error !== undefined).size();
+	const scriptsModified = changes.size() - failedScripts;
 	if (recordingId !== undefined) {
-		finishRecording(recordingId, changes.size() > 0);
+		finishRecording(recordingId, scriptsModified > 0);
 	}
 
 	return {
-		success: true,
+		success: traversalSuccess && failedScripts === 0,
+		error: traversalSuccess ? undefined : `Script traversal failed: ${traversalResult}`,
 		dryRun,
 		pattern: searchPattern,
 		replacement,
 		totalReplacements,
 		scriptsSearched,
-		scriptsModified: changes.size(),
+		scriptsModified,
+		scriptsFailed: failedScripts,
 		changes,
 		truncated: hitLimit,
 	};