feat: Reduce whitespace in tool responses by not formatting JSON (#284)

Based on my research, formatted JSON (i.e. using indentation) does not
seem to lead to improved LLM performance. This indicates that whitespace
tokens within JSON basically have no effect and can be removed safely.

By removing whitespaces, we can save on the overall token consumption
for affected tool calls.

Author: RandomByte

src/tools/get_api_reference/index.ts

@@ -38,7 +38,7 @@ function createResource(apiRef: FormattedSymbol, frameworkName: string, framewor
 	return {
 		type: "resource",
 		resource: {
-			text: JSON.stringify(apiRef, null, 2),
+			text: JSON.stringify(apiRef),
 			uri: createUriForSymbol(apiRef, frameworkName, frameworkVersion),
 			mimeType: "application/json",
 		},

src/tools/get_version_info/index.ts

@@ -29,7 +29,7 @@ export default function registerTool(registerTool: RegisterTool, _context: Conte
 		return {
 			content: [{
 				type: "text",
-				text: JSON.stringify(versionInfo, null, 2),
+				text: JSON.stringify(versionInfo),
 			}],
 			structuredContent: versionInfo,
 		};

src/tools/run_ui5_linter/index.ts

@@ -37,7 +37,7 @@ export default function registerTool(registerTool: RegisterTool, context: Contex
 		});
 		const content: (TextContent | EmbeddedResource)[] = [{
 			type: "text",
-			text: JSON.stringify(results.results, null, 2),
+			text: JSON.stringify(results.results),
 		}];
 		if (results.contextInformation) {
 			const {ruleDescriptions, documentationResources, migrationGuides, apiReferences} =
@@ -49,7 +49,7 @@ export default function registerTool(registerTool: RegisterTool, context: Contex
 					type: "resource",
 					resource: {
 						uri: `ui5-linter-result://${projectUri.pathname}/api-reference-extract-${timestamp}.json`,
-						text: JSON.stringify(apiReferences, null, 2),
+						text: JSON.stringify(apiReferences),
 						mimeType: "application/json",
 					},
 				});
@@ -77,7 +77,7 @@ export default function registerTool(registerTool: RegisterTool, context: Contex
 			if (ruleDescriptions.length) {
 				content.push({
 					type: "text",
-					text: JSON.stringify(ruleDescriptions, null, 2),
+					text: JSON.stringify(ruleDescriptions),
 				});
 			}
 		}

test/lib/tools/get_api_reference/index.ts

@@ -134,7 +134,7 @@ test("get_api_reference tool returns API reference on success", async (t) => {
 		content: [{
 			type: "resource",
 			resource: {
-				text: JSON.stringify(sampleApiRef, null, 2),
+				text: JSON.stringify(sampleApiRef),
 				uri: sampleUri,
 				mimeType: "application/json",
 			},

test/lib/tools/get_version_info/index.ts

@@ -89,7 +89,7 @@ test("get_version_info tool returns version information on success", async (t) =
 		content: [
 			{
 				type: "text",
-				text: JSON.stringify(sampleVersionInfo, null, 2),
+				text: JSON.stringify(sampleVersionInfo),
 			},
 		],
 	});

test/lib/tools/run_ui5_linter/index.ts

@@ -112,7 +112,7 @@ test("run_ui5_linter tool returns linting results on success with no context inf
 		content: [
 			{
 				type: "text",
-				text: JSON.stringify(sampleResults.results, null, 2),
+				text: JSON.stringify(sampleResults.results),
 			},
 		],
 	});
@@ -208,7 +208,7 @@ test("run_ui5_linter tool returns linting results with context information", asy
 	// Check the first content item (text with results)
 	t.deepEqual(result.content[0], {
 		type: "text",
-		text: JSON.stringify(sampleResults.results, null, 2),
+		text: JSON.stringify(sampleResults.results),
 	});
 
 	// Check the second content item (extracted API references)
@@ -223,7 +223,7 @@ test("run_ui5_linter tool returns linting results with context information", asy
 		type: "resource",
 		resource: {
 			uri: `ui5-linter-result://${pathToFileURL(path.join(projectDir, "api-reference-extract")).pathname}-<timestamp>.json`,
-			text: JSON.stringify(sampleResults.contextInformation.apiReferences, null, 2),
+			text: JSON.stringify(sampleResults.contextInformation.apiReferences),
 			mimeType: "application/json",
 		},
 	});
@@ -251,7 +251,7 @@ test("run_ui5_linter tool returns linting results with context information", asy
 	// Check the fifth content item (rule descriptions)
 	t.deepEqual(result.content[4], {
 		type: "text",
-		text: JSON.stringify(sampleResults.contextInformation.ruleDescriptions, null, 2),
+		text: JSON.stringify(sampleResults.contextInformation.ruleDescriptions),
 	});
 });