@skyramp/mcp 0.0.2 → 0.0.4

package/README.md

@@ -83,9 +83,11 @@ Add the following configuration. For more information, read the [Cursor MCP docu
 }
 ```
 
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=skyramp-mcp&config=eyJjb21tYW5kIjoibnB4IC15IEBza3lyYW1wL21jcEBsYXRlc3QifQ==)
+[![Install MCP Server on MacOS](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=skyramp-mcp&config=eyJjb21tYW5kIjoibnB4IC15IEBza3lyYW1wL21jcEBsYXRlc3QifQ==)
 
-**For Claude Desktop, you must set the `HOME` environment variable in your MCP server configuration.**
+### Note: To pull latest changes restart the MCP server
+
+### For Claude Desktop, you must set the `HOME` environment variable in your MCP server configuration
 
 This is required because some tools expect a valid home directory for file operations. Set `HOME` to the path where you want Skyramp to generate and execute tests. For example:
 
@@ -118,7 +120,7 @@ On Windows, you might need to use this alternative configuration:
 }
 ```
 
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=skyramp-mcp&config=eyJjb21tYW5kIjoiY21kIC9rIG5weCAteSBAc2t5cmFtcC9tY3BAbGF0ZXN0In0=)
+[![Install MCP Server on Windows](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=skyramp-mcp&config=eyJjb21tYW5kIjoiY21kIC9rIG5weCAteSBAc2t5cmFtcC9tY3BAbGF0ZXN0In0=)
 
 ## Available tools
 

package/build/prompts/startTraceCollectionPrompts.js

@@ -5,6 +5,7 @@ import { logger } from "../utils/logger.js";
 const isDockerEnv = process.env.MCP_SERVER_RUNTIME === "docker";
 logger.info("MCP server runtime environment", { isDockerEnv });
 export function registerStartTraceCollectionPrompt(mcpServer) {
+    logger.info("registering start trace collection prompt");
     mcpServer.prompt("skyramp_trace_prompt", "Skyramp trace collection prompt", {
         include: z
             .string()

package/build/prompts/testGenerationPrompt.js

@@ -1,18 +1,11 @@
 // src/prompts/skyrampPrompt.ts
-import { z } from "zod";
 import { logger } from "../utils/logger.js";
 // read env variable and use it to set custom prompt
 const isDockerEnv = process.env.MCP_SERVER_RUNTIME === "docker";
 logger.info("MCP server runtime environment", { isDockerEnv });
 export function registerTestGenerationPrompt(mcpServer) {
-    mcpServer.prompt("skyramp_test_generation_prompt", "Skyramp test generation prompt", {
-        endpointURL: z.string().optional(),
-        outputDir: z.string().optional(),
-        trace: z.string().optional().describe("MUST be absolute path"),
-        playwrightTrace: z.string().optional().describe("MUST be absolute path"),
-        schemaInput: z.string().optional().describe("MUST be absolute path"),
-        parameters: z.string().optional(),
-    }, ({ endpointURL, outputDir, trace, playwrightTrace, schemaInput, parameters, }) => ({
+    logger.info("test generation prompt");
+    mcpServer.prompt("skyramp_test_generation_prompt", "Skyramp test generation prompt", {}, () => ({
         messages: [
             {
                 role: "user",

package/build/services/TestGenerationService.js

@@ -18,17 +18,111 @@ export class TestGenerationService {
                 return apiAnalysisResult;
             }
             const result = await this.executeGeneration(generateOptions);
+            let modularizedResultPrompt = `
+**IMPORTANT: Now please modularize the code by**
+
+1. Group related lines logically (e.g., login steps together) to improve readability.
+2. Parameterize the test function(s) with meaningful parameters to make it more flexible. Preserve the original order of code lines within each function
+3. Do not change or remove any existing lines of code, variable names, function names, or function structures.
+4. Only extract reusable logical sections into helper functions or parameterized structures where applicable.
+5. Do not create any new test cases but only helper functions.
+6. Make sure the logic is same and the test works as expected.
+7. Do not add any new logic or classes or any other files.
+
+Please refactor the code with these modularization principles.
+      `;
+            let languageSteps = "";
+            switch (params.language) {
+                case "python":
+                    // python steps
+                    languageSteps += `
+# Install skyramp dependency
+pip3 install skyramp
+        `;
+                    // e2e and ui tests
+                    if (params.testType == "e2e" || params.testType == "ui") {
+                        languageSteps += `
+# Install playwright dependencies
+pip3 install pytest-playwright
+# Execute the test file
+python3 -m pytest --browser chromium <test-file>.py
+            `;
+                    }
+                    //framework pytest
+                    languageSteps += `
+# Install pytest dependency
+pip3 install pytest
+
+# Execution test file
+python3 -m pytest <test-file>.py
+          `;
+                    // robot framework
+                    languageSteps += `
+# Install robotframework dependency
+pip3 install robotframework
+
+# Execution of test file
+python3 -m robot <robot-file>.robot
+        `;
+                    break;
+                case "javascript":
+                    languageSteps += `
+# install dependencies for package.json
+npm install @skyramp/skyramp @playwright/test
+
+# Execution of test file
+npx playwright test <test-file>.spec.js --reporter=list
+          `;
+                    break;
+                case "typescript":
+                    languageSteps += `
+# install dependencies for package.json
+npm install @skyramp/skyramp @playwright/test
+
+# Execution of test file
+npx playwright test <test-file>.spec.ts --reporter=list
+          `;
+                    break;
+                case "java":
+                    languageSteps += `
+# Prerequisites
+# Compile the test file
+javac -cp "./lib/*" -d target <test-file>.java
+
+# Execution of test file
+JUNIT_PLATFORM_VER="1.9.3"
+classpath="target:$(echo ./lib/*.jar | tr ' ' ':')"
+java -jar "./lib/junit-platform-console-standalone-\${JUNIT_PLATFORM_VER}.jar" \\
+  --classpath "\$classpath" \\
+  --include-engine=junit-jupiter \\
+  --select-class=<test-file> \\
+  --reports-dir=target/test-results
+          `;
+                    break;
+            }
+            let isError = false;
+            // check the result include 'Successfully generated/updated tests files:'
+            if (!result.includes("Successfully generated/updated tests files:")) {
+                isError = true;
+            }
+            const testType = this.getTestType();
+            const shouldModularize = testType == "ui" || testType == "e2e";
             return {
                 content: [
                     {
                         type: "text",
-                        text: `${result}
+                        text: `${shouldModularize
+                            ? "Generated the test and WILL NOW MODULARIZE THE CODE USING THE FOLLOWING MODULARIZATION PRINCIPLES"
+                            : "Generated the test and DO NOT MODULARIZE THE CODE"}
+            ${result} ${shouldModularize ? modularizedResultPrompt : ""}
+        ${languageSteps}
 
-If the test is successfully created, I can go ahead and refactor your test code to make it modular and reusable?
-Reply "yes" to continue, or "no" to skip this step.`,
+        - Notify the user that they can also use **Execute with Skyramp** tool to run the test. If this is your first test you are trying to execute with Skyramp, it may take a little bit longer than usual.
+        - Before I can execute the test for you, I need to confirm the following information:
+          Authentication: Please provide me with your authentication token (by default we assume a Bearer Token). If you don't require any token for your service please just say: 'No token required'`,
                     },
                 ],
-                isError: false,
+                isError: isError,
             };
         }
         catch (error) {

package/build/tools/executeSkyrampTestTool.js

@@ -13,7 +13,9 @@ const LANGUAGE_PATHS = {
 export function registerExecuteSkyrampTestTool(server) {
     server.registerTool("skyramp_execute_test", {
         description: `Execute a Skyramp test to validate your application using isolated containerized environments.
-      Before I can execute the test for you, I need to confirm the following information:
+      IMPORTANT: Follow the instructions below to execute the test.
+      - Notify the user that the first time the tool is used, it will take some time to pull the image.
+      - Before I can execute the test for you, I need to confirm the following information:
       Authentication: Please provide me with your authentication token (by default we assume a Bearer Token). If you don't require any token for your service please just say: 'No token required'`,
         inputSchema: {
             language: z
@@ -27,7 +29,7 @@ export function registerExecuteSkyrampTestTool(server) {
                 .describe("ALWAYS USE ABSOLUTE PATH to the test file to execute"),
             token: z
                 .string()
-                .describe("Skyramp authentication token for test execution. Use '' when user confirms 'No token required'"),
+                .describe("Skyramp authentication token for test execution. USE EMPTY STRING WHEN USER CONFIRMS 'No token required'"),
         },
         annotations: {
             keywords: ["run test", "execute test"],
@@ -98,7 +100,7 @@ export function registerExecuteSkyrampTestTool(server) {
                 stream.end();
                 statusCode = result.StatusCode;
                 logger.debug("Docker container execution completed");
-                return container.remove();
+                return container;
             })
                 .then(function (data) {
                 logger.debug("Docker container removed successfully");

package/build/types/TestTypes.js

@@ -73,7 +73,7 @@ export const baseTestSchema = {
     method: z
         .string()
         .optional()
-        .describe("HTTP method to use (GET, POST, PUT, DELETE, etc.)"),
+        .describe("HTTP method to use (GET, POST, PUT, DELETE, etc.). DO NOT ASSUME METHOD IF NOT PROVIDED AND TRY TO DETECT THE METHOD FROM OPENAPI SCHEMA"),
     apiSchema: z
         .string()
         .optional()
@@ -97,5 +97,5 @@ export const baseTestSchema = {
     responseStatusCode: z
         .string()
         .optional()
-        .describe("Expected HTTP response status code (e.g., '200', '201', '404')"),
+        .describe("Expected HTTP response status code (e.g., '200', '201', '404'). DO NOT ASSUME STATUS CODE IF NOT PROVIDED AND TRY TO DETECT THE STATUS CODE FROM OPENAPI SCHEMA"),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/mcp",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "build/index.js",
   "type": "module",
   "bin": {
@@ -58,4 +58,4 @@
   "engines": {
     "node": ">=18"
   }
-}
+}