@skyramp/mcp 0.0.34 → 0.0.35

package/build/index.js

@@ -2,24 +2,24 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { registerStartTraceCollectionPrompt } from "./prompts/startTraceCollectionPrompts.js";
-import { registerTraceTool } from "./tools/startTraceCollectionTool.js";
-import { registerTraceStopTool } from "./tools/stopTraceCollectionTool.js";
+import { registerTraceTool } from "./tools/trace/startTraceCollectionTool.js";
+import { registerTraceStopTool } from "./tools/trace/stopTraceCollectionTool.js";
 import { registerExecuteSkyrampTestTool } from "./tools/executeSkyrampTestTool.js";
 import { registerTestGenerationPrompt } from "./prompts/testGenerationPrompt.js";
 import { logger } from "./utils/logger.js";
-import { registerUITestTool } from "./tools/generateUIRestTool.js";
-import { registerSmokeTestTool } from "./tools/generateSmokeRestTool.js";
-import { registerFuzzTestTool } from "./tools/generateFuzzRestTool.js";
-import { registerContractTestTool } from "./tools/generateContractRestTool.js";
-import { registerLoadTestTool } from "./tools/generateLoadRestTool.js";
-import { registerIntegrationTestTool } from "./tools/generateIntegrationRestTool.js";
-import { registerE2ETestTool } from "./tools/generateE2ERestTool.js";
-import { registerLoginTool } from "./tools/loginTool.js";
-import { registerLogoutTool } from "./tools/logoutTool.js";
+import { registerUITestTool } from "./tools/generate-tests/generateUIRestTool.js";
+import { registerSmokeTestTool } from "./tools/generate-tests/generateSmokeRestTool.js";
+import { registerFuzzTestTool } from "./tools/generate-tests/generateFuzzRestTool.js";
+import { registerContractTestTool } from "./tools/generate-tests/generateContractRestTool.js";
+import { registerLoadTestTool } from "./tools/generate-tests/generateLoadRestTool.js";
+import { registerIntegrationTestTool } from "./tools/generate-tests/generateIntegrationRestTool.js";
+import { registerE2ETestTool } from "./tools/generate-tests/generateE2ERestTool.js";
+import { registerLoginTool } from "./tools/auth/loginTool.js";
+import { registerLogoutTool } from "./tools/auth/logoutTool.js";
 import { registerFixErrorTool } from "./tools/fixErrorTool.js";
-import { registerModularizationTool } from "./tools/modularizationTool.js";
-import { registerCodeReuseTool } from "./tools/codeReuseTool.js";
-import { registerScenarioTestTool } from "./tools/generateScenarioRestTool.js";
+import { registerModularizationTool } from "./tools/code-refactor/modularizationTool.js";
+import { registerCodeReuseTool } from "./tools/code-refactor/codeReuseTool.js";
+import { registerScenarioTestTool } from "./tools/generate-tests/generateScenarioRestTool.js";
 const server = new McpServer({
     name: "Skyramp MCP Server",
     version: "1.0.0",
@@ -34,28 +34,40 @@ const server = new McpServer({
 });
 // Register prompts
 logger.info("Starting prompt registration process");
-registerTestGenerationPrompt(server);
-registerStartTraceCollectionPrompt(server);
+const prompts = [
+    registerTestGenerationPrompt,
+    registerStartTraceCollectionPrompt,
+];
+prompts.forEach((registerPrompt) => registerPrompt(server));
 logger.info("All prompts registered successfully");
 // Register test generation tools
-registerSmokeTestTool(server);
-registerFuzzTestTool(server);
-registerContractTestTool(server);
-registerLoadTestTool(server);
-registerIntegrationTestTool(server);
-registerE2ETestTool(server);
-registerUITestTool(server);
-registerScenarioTestTool(server);
-// Register modularization and fix error tools
-registerModularizationTool(server);
-registerFixErrorTool(server);
-registerCodeReuseTool(server);
+const testGenerationTools = [
+    registerSmokeTestTool,
+    registerFuzzTestTool,
+    registerContractTestTool,
+    registerLoadTestTool,
+    registerIntegrationTestTool,
+    registerE2ETestTool,
+    registerUITestTool,
+    registerScenarioTestTool,
+];
+testGenerationTools.forEach((registerTool) => registerTool(server));
+// Register modularization and code quality tools
+const codeQualityTools = [
+    registerModularizationTool,
+    registerFixErrorTool,
+    registerCodeReuseTool,
+];
+codeQualityTools.forEach((registerTool) => registerTool(server));
 // Register other Skyramp tools
-registerLoginTool(server);
-registerLogoutTool(server);
-registerExecuteSkyrampTestTool(server);
-registerTraceTool(server);
-registerTraceStopTool(server);
+const infrastructureTools = [
+    registerLoginTool,
+    registerLogoutTool,
+    registerExecuteSkyrampTestTool,
+    registerTraceTool,
+    registerTraceStopTool,
+];
+infrastructureTools.forEach((registerTool) => registerTool(server));
 // Start MCP server
 async function main() {
     const transport = new StdioServerTransport();

package/build/prompts/modularization/integration-test-modularization.js

@@ -1,7 +1,8 @@
 export function getModularizationPrompt(filePath) {
     return `# INTEGRATION TEST MODULARIZATION - SIMPLE AND SAFE
 
-**WRITE MODULARIZED CODE TO: ${filePath}**
+**CRITICAL: Use the 'write' tool to save the modularized code to: ${filePath}**
+**DO NOT use search_replace - use the 'write' tool to overwrite the entire file with the modularized version**
 
 **ABSOLUTELY FORBIDDEN:**
 - DO NOT CREATE ANY INTERFACES, CLASSES, TYPES, OR NEW DATA STRUCTURES. USE INLINE TYPES ONLY.

package/build/prompts/modularization/ui-test-modularization.js

@@ -1,7 +1,8 @@
 export function getModularizationPrompt(filePath) {
     return `# UI TEST MODULARIZATION - IMPROVE READABILITY AND REDUCE DUPLICATION
 
-**WRITE MODULARIZED CODE TO: ${filePath}**
+**CRITICAL: Use the 'write' tool to save the modularized code to: ${filePath}**
+**DO NOT use search_replace - use the 'write' tool to overwrite the entire file with the modularized version**
 
 **ABSOLUTELY FORBIDDEN:**
 - DO NOT CREATE INTERFACES, CLASSES, TYPES, NEW FILES, OR NEW DATA STRUCTURES

package/build/prompts/testGenerationPrompt.js

@@ -16,6 +16,7 @@ export function registerTestGenerationPrompt(mcpServer) {
 - Answer questions about Skyramp capabilities and testing concepts
 - ALWAYS SHOW STEPS TO GENERATE TEST USING MCP TOOLS AND NEVER SHOW THE CLI COMMANDS.
 - CRITICAL: UI, INTEGRATION, E2E TESTS MUST BE MODULARIZED USING skyramp_modularization TOOL. ALWAYS ADD A TASK TO MODULARIZE THE TEST USING skyramp_modularization TOOL AFTER GENERATING THESE(UI, INTEGRATION, E2E) TESTS.
+- **CRITICAL: skyramp_reuse_code TOOL MUST BE CALLED IF DURING THE TEST GENERATION THE CODE REUSE FLAG IS SET TO TRUE EXPLICITLY BY THE USER.**
 
 **CONTRACT TEST:**
 - Purpose: Ensures a service is properly communicating with another service
@@ -185,6 +186,8 @@ Trace File:
 - FOR SCENARIO PARSING, ALWAYS REQUIRE AN API SCHEMA FOR ACCURATE ENDPOINT MAPPING.
 - SCENARIO PARSING ONLY RETURNS JSON ARRAYS - USE OTHER TOOLS FOR ACTUAL TEST GENERATION.
 
+**CRITICAL: FOR A SINGLE SCENARIO CREATE A SINGLE SCENARIO FILE WITH EACH STEP AS A JSON OBJECT IN THE ARRAY.**
+
 **CRITICAL: SHOW STEPS TO START/STOP PLAYWRIGHT TRACE COLLECTION FOR UI TESTS. NEVER SHOW THE CLI COMMANDS.**
             `,
                 },

package/build/services/ModularizationService.js

@@ -30,7 +30,11 @@ export class ModularizationService {
                 {
                     type: "text",
                     text: prompt +
-                        `\n\n***CRITICAL: After modularization is complete, proceed to skyramp_reuse_code tool to fix any errors.`,
+                        `\n\n***CRITICAL INSTRUCTIONS:***
+1. Read the test file using the 'read_file' tool
+2. Create the modularized version following the instructions above
+3. Use the 'write' tool (NOT search_replace) to save the complete modularized code to the file
+4. After modularization is complete, proceed to skyramp_fix_errors tool if there are any errors`,
                 },
             ],
         };

package/build/services/ScenarioGenerationService.js

@@ -118,7 +118,7 @@ ${JSON.stringify(traceRequest, null, 2)}
         }
     }
     generateTraceRequestFromInput(params) {
-        const destination = this.extractDestinationFromSchema(params.apiSchema);
+        const destination = params.destination;
         // Use AI-provided parameters instead of parsing
         const timestamp = new Date().toISOString();
         const method = params.method;
@@ -151,17 +151,4 @@ ${JSON.stringify(traceRequest, null, 2)}
             Scheme: "https",
         };
     }
-    extractDestinationFromSchema(apiSchema) {
-        // If it's a URL, extract destination; if it's a file path, use default
-        if (apiSchema.startsWith("http")) {
-            try {
-                const url = new URL(apiSchema);
-                return url.host;
-            }
-            catch {
-                return "api.example.com";
-            }
-        }
-        return "api.example.com";
-    }
 }

package/build/services/TestGenerationService.js

@@ -194,6 +194,7 @@ ${result}`;
             generateExclude: params.exclude,
             generateInsecure: params.insecure,
             entrypoint: TELEMETRY_entrypoint_FIELD_NAME,
+            chainingKey: params.chainingKey,
         };
     }
 }

package/build/tools/__tests__/codeReuseTool.test.js

@@ -1,5 +1,5 @@
 import { describe, it, expect, beforeEach, jest } from "@jest/globals";
-import { registerCodeReuseTool } from "../codeReuseTool.js";
+import { registerCodeReuseTool } from "../code-refactor/codeReuseTool.js";
 import { getCodeReusePrompt } from "../../prompts/code-reuse.js";
 // Mock the logger
 jest.mock("../../utils/logger", () => ({

package/build/tools/{loginTool.js → auth/loginTool.js}

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { SkyrampClient } from "@skyramp/skyramp";
-import { logger } from "../utils/logger.js";
+import { logger } from "../../utils/logger.js";
 export function registerLoginTool(server) {
     server.registerTool("skyramp_login", {
         description: `Login to Skyramp platform 

package/build/tools/{logoutTool.js → auth/logoutTool.js}

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { SkyrampClient } from "@skyramp/skyramp";
-import { logger } from "../utils/logger.js";
+import { logger } from "../../utils/logger.js";
 export function registerLogoutTool(server) {
     server.registerTool("skyramp_logout", {
         description: `Logout from Skyramp platform

package/build/tools/{codeReuseTool.js → code-refactor/codeReuseTool.js}

@@ -1,8 +1,8 @@
 import { z } from "zod";
-import { logger } from "../utils/logger.js";
-import { getCodeReusePrompt } from "../prompts/code-reuse.js";
-import { codeRefactoringSchema, languageSchema } from "../types/TestTypes.js";
-import { SKYRAMP_UTILS_HEADER } from "../utils/utils.js";
+import { logger } from "../../utils/logger.js";
+import { getCodeReusePrompt } from "../../prompts/code-reuse.js";
+import { codeRefactoringSchema, languageSchema, } from "../../types/TestTypes.js";
+import { SKYRAMP_UTILS_HEADER } from "../../utils/utils.js";
 const codeReuseSchema = z.object({
     testFile: z
         .string()
@@ -21,13 +21,14 @@ export function registerCodeReuseTool(server) {
       This tool helps identify and reuse ONLY EXISTING helper functions from other test files (grep based on "${SKYRAMP_UTILS_HEADER}"). 
       
       **CRITICAL RULES - VIOLATION WILL RESULT IN ERROR:**
-      1. DO NOT create new helper functions - only find and reuse existing ones
-      2. ONLY create a utils file if ACTUAL helper functions (with signatures) exist in OTHER test files
-      3. DO NOT create utils files for repetitive patterns - that's refactoring, not reuse
-      4. DO NOT extract patterns from current or other test files - only move existing functions
-      5. If other test files are identical/similar with no helper functions, DO NOTHING
-      6. Helper functions must have explicit function definitions, not just patterns
-      7. If no existing helper functions found, test file remains unchanged
+      1. THIS TOOL MUST BE CALLED IF DURING THE TEST GENERATION THE CODE REUSE FLAG IS SET TO TRUE EXPLICITLY
+      2. DO NOT create new helper functions - only find and reuse existing ones
+      3. ONLY create a utils file if ACTUAL helper functions (with signatures) exist in OTHER test files
+      4. DO NOT create utils files for repetitive patterns - that's refactoring, not reuse
+      5. DO NOT extract patterns from current or other test files - only move existing functions
+      6. If other test files are identical/similar with no helper functions, DO NOTHING
+      7. Helper functions must have explicit function definitions, not just patterns
+      8. If no existing helper functions found, test file remains unchanged
       
 
       **WORKFLOW SUMMARY:**

package/build/tools/{modularizationTool.js → code-refactor/modularizationTool.js}

@@ -1,7 +1,7 @@
 import { z } from "zod";
-import { logger } from "../utils/logger.js";
-import { TestType } from "../types/TestTypes.js";
-import { ModularizationService, } from "../services/ModularizationService.js";
+import { logger } from "../../utils/logger.js";
+import { TestType } from "../../types/TestTypes.js";
+import { ModularizationService, } from "../../services/ModularizationService.js";
 const modularizationSchema = {
     testFile: z
         .string()
@@ -9,7 +9,7 @@ const modularizationSchema = {
     language: z.string().describe("The programming language of the test file"),
     testType: z
         .enum([TestType.UI, TestType.E2E, TestType.INTEGRATION])
-        .describe("Specifies the type of test (UI, E2E, or Integration)"),
+        .describe("Specifies the type of test (UI, E2E, or Integration). DO NOT USE TEST NAME/DESCRIPTION AS TEST TYPE. ONLY USE UI, E2E, OR INTEGRATION."),
     prompt: z
         .string()
         .describe("The prompt or code content to process with modularization principles applied"),

package/build/tools/executeSkyrampTestTool.js

@@ -5,7 +5,7 @@ import { Writable } from "stream";
 import { logger } from "../utils/logger.js";
 import { stripVTControlCharacters } from "util";
 import fs from "fs";
-const EXECUTOR_DOCKER_IMAGE = "skyramp/executor:v1.2.24";
+const EXECUTOR_DOCKER_IMAGE = "skyramp/executor:v1.2.27";
 const DOCKER_PLATFORM = "linux/amd64";
 export function registerExecuteSkyrampTestTool(server) {
     server.registerTool("skyramp_execute_test", {

package/build/tools/{generateContractRestTool.js → generate-tests/generateContractRestTool.js}

@@ -1,6 +1,6 @@
 import { z } from "zod";
-import { baseTestSchema, TestType } from "../types/TestTypes.js";
-import { TestGenerationService, } from "../services/TestGenerationService.js";
+import { baseTestSchema, TestType } from "../../types/TestTypes.js";
+import { TestGenerationService, } from "../../services/TestGenerationService.js";
 const contractTestSchema = {
     ...baseTestSchema,
     assertOptions: z

package/build/tools/{generateE2ERestTool.js → generate-tests/generateE2ERestTool.js}

@@ -1,6 +1,6 @@
 import { z } from "zod";
-import { baseSchema, baseTraceSchema, TestType, codeRefactoringSchema, } from "../types/TestTypes.js";
-import { TestGenerationService, } from "../services/TestGenerationService.js";
+import { baseSchema, baseTraceSchema, TestType, codeRefactoringSchema, } from "../../types/TestTypes.js";
+import { TestGenerationService, } from "../../services/TestGenerationService.js";
 const e2eTestSchema = {
     ...baseTraceSchema.shape,
     playwrightInput: z

package/build/tools/{generateFuzzRestTool.js → generate-tests/generateFuzzRestTool.js}

@@ -1,5 +1,5 @@
-import { baseTestSchema, TestType } from "../types/TestTypes.js";
-import { TestGenerationService, } from "../services/TestGenerationService.js";
+import { baseTestSchema, TestType } from "../../types/TestTypes.js";
+import { TestGenerationService, } from "../../services/TestGenerationService.js";
 import { z } from "zod";
 const fuzzTestSchema = {
     ...baseTestSchema,

package/build/tools/{generateIntegrationRestTool.js → generate-tests/generateIntegrationRestTool.js}

@@ -1,9 +1,13 @@
 import { z } from "zod";
-import { baseTestSchema, baseTraceSchema, TestType, codeRefactoringSchema, } from "../types/TestTypes.js";
-import { TestGenerationService, } from "../services/TestGenerationService.js";
+import { baseTestSchema, baseTraceSchema, TestType, codeRefactoringSchema, } from "../../types/TestTypes.js";
+import { TestGenerationService, } from "../../services/TestGenerationService.js";
 const integrationTestSchema = z
     .object({
     ...baseTestSchema,
+    chainingKey: z
+        .string()
+        .optional()
+        .describe("JSON path of POST response that will be used for chaining. Example: If asked to use item_id to chain the requests, please ensure chainingKey is set to item_id."),
     trace: baseTraceSchema.shape.trace.optional(),
     include: baseTraceSchema.shape.include.optional(),
     exclude: baseTraceSchema.shape.exclude.optional(),

package/build/tools/{generateLoadRestTool.js → generate-tests/generateLoadRestTool.js}

@@ -1,6 +1,6 @@
 import { z } from "zod";
-import { baseTestSchema, baseTraceSchema, TestType, } from "../types/TestTypes.js";
-import { TestGenerationService, } from "../services/TestGenerationService.js";
+import { baseTestSchema, baseTraceSchema, TestType, } from "../../types/TestTypes.js";
+import { TestGenerationService, } from "../../services/TestGenerationService.js";
 const loadTestSchema = {
     ...baseTestSchema,
     loadCount: z

package/build/tools/{generateScenarioRestTool.js → generate-tests/generateScenarioRestTool.js}

@@ -1,10 +1,13 @@
 import { z } from "zod";
-import { ScenarioGenerationService } from "../services/ScenarioGenerationService.js";
-import { baseSchema } from "../types/TestTypes.js";
+import { ScenarioGenerationService } from "../../services/ScenarioGenerationService.js";
+import { baseSchema } from "../../types/TestTypes.js";
 const scenarioTestSchema = {
     scenarioName: z
         .string()
         .describe("Name of the test scenario with multiple steps. Describe the complete workflow you want to test, including all actions and their sequence.KEEP IT SHORT AND DESCRIPTIVE AS USED FOR FILE NAME"),
+    destination: z
+        .string()
+        .describe("Destination host (e.g., api.example.com) to be used for the test"),
     apiSchema: z
         .string()
         .describe("MUST be absolute path (/path/to/openapi.json) to the OpenAPI/Swagger schema file or a URL to the OpenAPI/Swagger schema file (e.g. https://demoshop.skyramp.dev/openapi.json). Required for accurate API mapping."),

package/build/tools/{generateSmokeRestTool.js → generate-tests/generateSmokeRestTool.js}

@@ -1,5 +1,5 @@
-import { baseTestSchema, TestType } from "../types/TestTypes.js";
-import { TestGenerationService, } from "../services/TestGenerationService.js";
+import { baseTestSchema, TestType } from "../../types/TestTypes.js";
+import { TestGenerationService, } from "../../services/TestGenerationService.js";
 import z from "zod";
 // Concrete implementations for each test type
 export class SmokeTestService extends TestGenerationService {

package/build/tools/{generateUIRestTool.js → generate-tests/generateUIRestTool.js}

@@ -1,6 +1,6 @@
-import { baseSchema, languageSchema, TestType, codeRefactoringSchema, } from "../types/TestTypes.js";
+import { baseSchema, languageSchema, TestType, codeRefactoringSchema, baseTraceSchema, } from "../../types/TestTypes.js";
 import { z } from "zod";
-import { TestGenerationService, } from "../services/TestGenerationService.js";
+import { TestGenerationService, } from "../../services/TestGenerationService.js";
 export class UITestService extends TestGenerationService {
     getTestType() {
         return TestType.UI;
@@ -22,6 +22,12 @@ const uiTestSchema = {
     playwrightInput: z
         .string()
         .describe("MUST be absolute path to the playwright input file like /path/to/playwright-ui-test.zip and MUST be a zip file captured using start_trace_collection tool"),
+    include: baseTraceSchema.shape.include
+        .optional()
+        .describe("Array of FQDN strings to only include from trace data when correlating frontend actions with backend calls"),
+    exclude: baseTraceSchema.shape.exclude
+        .optional()
+        .describe("Array of FQDN strings to exclude from trace data when correlating frontend actions with backend calls"),
     output: baseSchema.shape.output,
     outputDir: baseSchema.shape.outputDir,
     force: baseSchema.shape.force,

package/build/tools/{startTraceCollectionTool.js → trace/startTraceCollectionTool.js}

@@ -1,8 +1,8 @@
 import { z } from "zod";
 import { SkyrampClient } from "@skyramp/skyramp";
-import openProxyTerminalTracked from "../utils/proxy-terminal.js";
-import { TELEMETRY_entrypoint_FIELD_NAME } from "../utils/utils.js";
-import { logger } from "../utils/logger.js";
+import openProxyTerminalTracked from "../../utils/proxy-terminal.js";
+import { TELEMETRY_entrypoint_FIELD_NAME } from "../../utils/utils.js";
+import { logger } from "../../utils/logger.js";
 export function registerTraceTool(server) {
     server.registerTool("skyramp_start_trace_collection", {
         description: `Start trace collection using Skyramp's comprehensive tracing capabilities.

package/build/tools/{stopTraceCollectionTool.js → trace/stopTraceCollectionTool.js}

@@ -1,9 +1,9 @@
 import { SkyrampClient } from "@skyramp/skyramp";
-import { closeProxyTerminal } from "../utils/proxy-terminal.js";
+import { closeProxyTerminal } from "../../utils/proxy-terminal.js";
 import { z } from "zod";
-import { TELEMETRY_entrypoint_FIELD_NAME } from "../utils/utils.js";
-import { logger } from "../utils/logger.js";
-import { baseSchema } from "../types/TestTypes.js";
+import { TELEMETRY_entrypoint_FIELD_NAME } from "../../utils/utils.js";
+import { logger } from "../../utils/logger.js";
+import { baseSchema } from "../../types/TestTypes.js";
 import { existsSync, mkdirSync } from "fs";
 export function registerTraceStopTool(server) {
     server.registerTool("skyramp_stop_trace_collection", {

package/build/types/TestTypes.js

@@ -61,6 +61,7 @@ export const baseSchema = z.object({
         .describe("MUST be absolute path to the directory where test files will be generated. If not provided, the CURRENT WORKING DIRECTORY will be used WITHOUT ANY SUBDIRECTORIES"),
     force: z
         .boolean()
+        .default(true)
         .describe("Whether to overwrite existing files in the output directory"),
     prompt: z.string().describe("The prompt user provided to generate the test"),
 });
@@ -71,11 +72,11 @@ export const baseTraceSchema = z.object({
     include: z
         .array(z.string())
         .default([])
-        .describe("List of endpoints or patterns to include in test generation. DO NOT ASSUME ANYTHING IF NOT PROVIDED"),
+        .describe("List of endpoints or patterns to include in test generation."),
     exclude: z
         .array(z.string())
         .default([])
-        .describe("List of endpoints or patterns to exclude from test generation. EXCLUDE THE PATHS THAT ARE NOT API ENDPOINTS."),
+        .describe("List of endpoints or patterns to exclude from test generation."),
     ...baseSchema.shape,
 });
 // Base schema that all test tools share

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/mcp",
-  "version": "0.0.34",
+  "version": "0.0.35",
   "main": "build/index.js",
   "type": "module",
   "bin": {
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.11.4",
-    "@skyramp/skyramp": "^1.2.24",
+    "@skyramp/skyramp": "^1.2.27",
     "@playwright/test": "^1.55.0",
     "dockerode": "^4.0.6",
     "zod": "^3.25.3"