@skyramp/mcp 0.3.2 → 0.3.4

package/build/tools/generate-tests/generateBatchScenarioRestTool.js

@@ -5,13 +5,16 @@ import { ScenarioGenerationService } from "../../services/ScenarioGenerationServ
 import fs from "fs";
 import { baseSchema, AUTH_PLACEHOLDER_TOKEN, HttpMethod } from "../../types/TestTypes.js";
 import { AnalyticsService } from "../../services/AnalyticsService.js";
-import { resolveAuthFromWorkspace, getWorkspaceDefaultQueryParams, mergeQueryParamsJson } from "../../utils/workspaceAuth.js";
+import { resolveAuthFromWorkspace, getWorkspaceScopedQueryParams, mergeQueryParamsJson } from "../../utils/workspaceAuth.js";
+import { resolveQueryParamsForPath, ensureLeadingSlash, contributesNothing } from "../../workspace/queryParamResolution.js";
+import { deriveBasePath } from "../../utils/urlPath.js";
 import yaml from "js-yaml";
 import { logger } from "../../utils/logger.js";
 import { guardScenarioApproved } from "./planGuard.js";
 import { lintScenarioChaining } from "./scenarioLint.js";
 import { scenarioFileNameFor } from "./scenarioFileIdentity.js";
 import { toolError } from "../../utils/utils.js";
+import { isRecord } from "ts-is-record";
 function isJsonValue(v) {
     if (v === undefined || v === null)
         return true;
@@ -40,8 +43,7 @@ function isJsonObject(v) {
     if (v === undefined || v === null)
         return true;
     try {
-        const p = JSON.parse(v);
-        return typeof p === "object" && !Array.isArray(p) && p !== null;
+        return isRecord(JSON.parse(v));
     }
     catch {
         return false;
@@ -83,7 +85,7 @@ Use this for GET request filters, search terms, pagination, sorting — any para
 
 CRITICAL: For search/filter/list endpoints (e.g., GET /products/search?q=bear&limit=10), parameters MUST go here, NOT in requestBody. GET request bodies are non-standard and may be ignored or rejected by servers and frameworks.
 
-Workspace-configured api.defaultQueryParams (if set) are merged into every step automatically — no need to repeat them here. An explicit value for the same key in a step overrides the workspace default for that step only.`),
+Workspace-configured api.defaultQueryParams (if set) are merged into every step automatically, and any api.queryParamOverrides entry whose pathPattern matches that step's path is layered on top — no need to repeat them here. An explicit value for the same key in a step overrides both, for that step only.`),
     responseBody: z
         .string()
         .optional()
@@ -253,13 +255,31 @@ Call \`skyramp_integration_test_generation\` with the returned \`scenarioFile\`
                 logger.warning("Could not resolve auth from workspace config");
             }
         }
-        let defaultQueryParams;
+        // Workspace-declared query params (SKYR-4050, path-scoped in SKYR-4127).
+        // Loaded once here; resolved per step below, since each step has its own
+        // path and may match a different override.
+        let scopedQueryParams;
+        // The request ScenarioGenerationService actually emits is basePath +
+        // step.path, so pathPattern matching has to see that same composed path —
+        // otherwise a prefix-inclusive pattern (as the workspace.yml schema docs
+        // instruct authors to write) never matches a scenario step (SKYR-4127
+        // final review). deriveBasePath is the one definition of that prefix,
+        // shared with the service itself so the two cannot drift.
+        let basePrefix = "";
         try {
             const repoPath = params.outputDir || process.cwd();
-            defaultQueryParams = await getWorkspaceDefaultQueryParams(repoPath);
-            if (defaultQueryParams) {
-                logger.info("Merged workspace defaultQueryParams into queryParams", {
-                    keys: Object.keys(defaultQueryParams),
+            scopedQueryParams = await getWorkspaceScopedQueryParams(repoPath);
+            if (scopedQueryParams && contributesNothing(scopedQueryParams)) {
+                // Skip the merge entirely rather than setting queryParams to "{}"
+                // where the old code left it untouched (Finding 4).
+                scopedQueryParams = undefined;
+            }
+            if (scopedQueryParams) {
+                basePrefix = deriveBasePath(params.baseURL);
+                logger.info("Loaded workspace query params for scenario steps", {
+                    baseKeys: Object.keys(scopedQueryParams.base),
+                    overrideCount: scopedQueryParams.overrides.length,
+                    basePrefix,
                 });
             }
         }
@@ -410,8 +430,8 @@ Call \`skyramp_integration_test_generation\` with the returned \`scenarioFile\`
                 method: step.method,
                 path: step.path,
                 requestBody: step.requestBody,
-                queryParams: defaultQueryParams
-                    ? mergeQueryParamsJson(step.queryParams, defaultQueryParams)
+                queryParams: scopedQueryParams
+                    ? mergeQueryParamsJson(step.queryParams, resolveQueryParamsForPath(scopedQueryParams, basePrefix + ensureLeadingSlash(step.path)))
                     : step.queryParams,
                 responseBody: step.responseBody,
                 statusCode: step.statusCode,

package/build/tools/generate-tests/planGuard.d.ts

@@ -1,10 +1,10 @@
 import { PlanMatchQuery } from "../../utils/planMatchKeys.js";
 export type PlanGuardQuery = PlanMatchQuery;
-/** Extract the URL path from a generation tool's `endpointURL` param — used
- *  for contract/direct-mode integration guard queries. Falls back to treating
- *  the value as a bare path when it isn't a parseable absolute URL, and to
- *  undefined (no path-based match attempted) when it's neither. */
-export declare function pathFromEndpointURL(endpointURL: string | undefined): string | undefined;
+/** Re-exported for the generation tools that already import it from here.
+ *  The implementation moved to utils/urlPath.ts (SKYR-4127) once workspace
+ *  query-param resolution needed the same derivation — see that module for why
+ *  it must not be copied. */
+export { pathFromEndpointURL } from "../../utils/urlPath.js";
 /**
  * Returns null when the generation call is allowed, or a human-readable error
  * message (for `toolError`) when it must be rejected because it doesn't match

package/build/tools/generate-tests/planGuard.js

@@ -7,23 +7,11 @@
 import { resolveRunStatePath, StateManager } from "../../utils/AnalysisStateManager.js";
 import { matchesApprovedPlan } from "../../utils/planMatchKeys.js";
 import { TOOL_REGISTER_TEST_PLAN } from "../../toolNames.js";
-/** Extract the URL path from a generation tool's `endpointURL` param — used
- *  for contract/direct-mode integration guard queries. Falls back to treating
- *  the value as a bare path when it isn't a parseable absolute URL, and to
- *  undefined (no path-based match attempted) when it's neither. */
-export function pathFromEndpointURL(endpointURL) {
-    if (!endpointURL)
-        return undefined;
-    try {
-        // new URL() percent-encodes {param} placeholders ({id} → %7Bid%7D), while
-        // register-time matchKeys are computed from raw scenario paths with braces
-        // intact — restore them or parameterized endpoints never match the plan.
-        return new URL(endpointURL).pathname.replace(/%7B/gi, "{").replace(/%7D/gi, "}");
-    }
-    catch {
-        return endpointURL.startsWith("/") ? endpointURL : undefined;
-    }
-}
+/** Re-exported for the generation tools that already import it from here.
+ *  The implementation moved to utils/urlPath.ts (SKYR-4127) once workspace
+ *  query-param resolution needed the same derivation — see that module for why
+ *  it must not be copied. */
+export { pathFromEndpointURL } from "../../utils/urlPath.js";
 /**
  * Returns null when the generation call is allowed, or a human-readable error
  * message (for `toolError`) when it must be rejected because it doesn't match

package/build/tools/queryProxyMocksTool.js

@@ -275,7 +275,6 @@ function startPortForward(kubeconfig, namespace, target, remotePort) {
 async function queryProtocolSamples(baseUrl, protocol, pageSize, destination) {
     const collected = [];
     let offset = 0;
-    // eslint-disable-next-line no-constant-condition
     while (true) {
         const params = new URLSearchParams({
             protocol,

package/build/tools/submitReportTool.d.ts

@@ -1,6 +1,20 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import { TestType, HttpMethod } from "../types/TestTypes.js";
+/**
+ * Filename of the report, written beside the state file. SKYR-4147: the report path is
+ * derived here rather than accepted as a parameter. The caller builds the state file and
+ * the report path from a single temp dir (testbot's `skyrampTempDir()`), so the state
+ * file's directory IS the directory the caller reads the report back from. Taking the
+ * path from the agent instead meant the agent had to retype it out of a 600-character
+ * encoded prompt URI; one wrong character wrote the report somewhere nobody reads, and
+ * the tool still reported success, throwing away the whole run without a word.
+ *
+ * Must stay in sync with testbot, which hardcodes the same string in main.ts, post.ts and
+ * eval-entry.ts — the same duplication across the two repos that already exists for
+ * `RUN_STATE_FILE_NAME` / testbot's `STATE_FILE_NAME`.
+ */
+export declare const REPORT_FILE_NAME = "testbot-result.txt";
 export declare const targetElementSchema: z.ZodObject<{
     role: z.ZodString;
     accessibleName: z.ZodString;
@@ -36,7 +50,7 @@ export declare const pageContextSchema: z.ZodObject<{
     url: string;
     pageHash?: string | undefined;
 }>;
-export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
+export declare const newTestSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     testId: z.ZodString;
     testType: z.ZodNativeEnum<typeof TestType>;
     category: z.ZodEffects<z.ZodEnum<["business_rule", "security_boundary", "data_integrity", "breaking_change", "auth", "error_handling", "workflow", "data_validation", "crud"]>, "business_rule" | "security_boundary" | "data_integrity" | "breaking_change" | "auth" | "error_handling" | "workflow" | "data_validation" | "crud", unknown>;
@@ -94,7 +108,6 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
     repository?: string | undefined;
     traceFile?: string | undefined;
     scenarioFile?: string | undefined;
-    frontendTrace?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -108,6 +121,7 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
+    frontendTrace?: string | undefined;
 }, {
     description: string;
     testType: TestType;
@@ -119,7 +133,6 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
     category?: unknown;
     traceFile?: string | undefined;
     scenarioFile?: string | undefined;
-    frontendTrace?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -133,6 +146,7 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
+    frontendTrace?: string | undefined;
 }>, {
     description: string;
     testType: TestType;
@@ -144,7 +158,6 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
     repository?: string | undefined;
     traceFile?: string | undefined;
     scenarioFile?: string | undefined;
-    frontendTrace?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -158,6 +171,7 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
+    frontendTrace?: string | undefined;
 }, {
     description: string;
     testType: TestType;
@@ -169,7 +183,31 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
     category?: unknown;
     traceFile?: string | undefined;
     scenarioFile?: string | undefined;
+    targetElements?: {
+        role: string;
+        accessibleName: string;
+        testId: string | null;
+        stableId: string | null;
+        contextText: string[] | null;
+        mutability?: "unknown" | "mutable" | "immutable" | undefined;
+        widgetType?: "unknown" | "custom" | "native" | undefined;
+    }[] | null | undefined;
+    pageContext?: {
+        url: string;
+        pageHash?: string | undefined;
+    } | undefined;
     frontendTrace?: string | undefined;
+}>, {
+    description: string;
+    testType: TestType;
+    category: "business_rule" | "security_boundary" | "data_integrity" | "breaking_change" | "auth" | "error_handling" | "workflow" | "data_validation" | "crud";
+    fileName: string;
+    endpoint: string;
+    testId: string;
+    reasoning: string;
+    repository?: string | undefined;
+    traceFile?: string | undefined;
+    scenarioFile?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -183,8 +221,9 @@ export declare const newTestSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
-}>;
-export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
+    frontendTrace?: string | undefined;
+}, unknown>;
+export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     testId: z.ZodString;
     testType: z.ZodNativeEnum<typeof TestType>;
     category: z.ZodEffects<z.ZodEnum<["business_rule", "security_boundary", "data_integrity", "breaking_change", "auth", "error_handling", "workflow", "data_validation", "crud"]>, "business_rule" | "security_boundary" | "data_integrity" | "breaking_change" | "auth" | "error_handling" | "workflow" | "data_validation" | "crud", unknown>;
@@ -271,7 +310,6 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
     reasoning: string;
     repository?: string | undefined;
     scenarioName?: string | undefined;
-    frontendTrace?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -285,6 +323,7 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
+    frontendTrace?: string | undefined;
     primaryEndpoint?: string | undefined;
     openApiSpec?: string | undefined;
     backendTrace?: string | undefined;
@@ -305,7 +344,6 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
     repository?: string | undefined;
     scenarioName?: string | undefined;
     category?: unknown;
-    frontendTrace?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -319,6 +357,7 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
+    frontendTrace?: string | undefined;
     primaryEndpoint?: string | undefined;
     openApiSpec?: string | undefined;
     backendTrace?: string | undefined;
@@ -339,7 +378,6 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
     reasoning: string;
     repository?: string | undefined;
     scenarioName?: string | undefined;
-    frontendTrace?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -353,6 +391,7 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
+    frontendTrace?: string | undefined;
     primaryEndpoint?: string | undefined;
     openApiSpec?: string | undefined;
     backendTrace?: string | undefined;
@@ -373,7 +412,40 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
     repository?: string | undefined;
     scenarioName?: string | undefined;
     category?: unknown;
+    targetElements?: {
+        role: string;
+        accessibleName: string;
+        testId: string | null;
+        stableId: string | null;
+        contextText: string[] | null;
+        mutability?: "unknown" | "mutable" | "immutable" | undefined;
+        widgetType?: "unknown" | "custom" | "native" | undefined;
+    }[] | null | undefined;
+    pageContext?: {
+        url: string;
+        pageHash?: string | undefined;
+    } | undefined;
     frontendTrace?: string | undefined;
+    primaryEndpoint?: string | undefined;
+    openApiSpec?: string | undefined;
+    backendTrace?: string | undefined;
+}>, {
+    description: string;
+    priority: "high" | "medium" | "low";
+    testType: TestType;
+    category: "business_rule" | "security_boundary" | "data_integrity" | "breaking_change" | "auth" | "error_handling" | "workflow" | "data_validation" | "crud";
+    steps: {
+        description: string;
+        path?: string | undefined;
+        method?: HttpMethod | undefined;
+        requestBody?: Record<string, any> | undefined;
+        responseBody?: Record<string, any> | undefined;
+        expectedStatusCode?: number | undefined;
+    }[];
+    testId: string;
+    reasoning: string;
+    repository?: string | undefined;
+    scenarioName?: string | undefined;
     targetElements?: {
         role: string;
         accessibleName: string;
@@ -387,8 +459,9 @@ export declare const additionalRecommendationSchema: z.ZodEffects<z.ZodObject<{
         url: string;
         pageHash?: string | undefined;
     } | undefined;
+    frontendTrace?: string | undefined;
     primaryEndpoint?: string | undefined;
     openApiSpec?: string | undefined;
     backendTrace?: string | undefined;
-}>;
+}, unknown>;
 export declare function registerSubmitReportTool(server: McpServer): void;