@smartbear/mcp 0.4.0 → 0.6.0

package/dist/pactflow/client.js

@@ -1,5 +1,7 @@
-import { TOOLS } from "./client/tools.js";
 import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
+import { TOOLS } from "./client/tools.js";
+import { getOADMatcherRecommendations, getUserMatcherSelection } from "./client/prompt-utils.js";
+import { PROMPTS } from "./client/prompts.js";
 // Tool definitions for PactFlow AI API client
 export class PactflowClient {
     name = "Contract Testing";
@@ -8,7 +10,16 @@ export class PactflowClient {
     aiBaseUrl;
     baseUrl;
     clientType;
-    constructor(auth, baseUrl, clientType) {
+    server;
+    /**
+     * Creates an instance of the PactflowClient.
+     *
+     * @param auth The authentication token or credentials.
+     * @param baseUrl The base URL for the API.
+     * @param clientType The type of client (e.g., PactFlow, Pact Broker).
+     * @param server The SmartBear MCP server instance.
+     */
+    constructor(auth, baseUrl, clientType, server) {
         // Set headers based on the type of auth provided
         if (typeof auth === "string") {
             this.headers = {
@@ -28,34 +39,87 @@ export class PactflowClient {
         this.baseUrl = baseUrl;
         this.aiBaseUrl = `${this.baseUrl}/api/ai`;
         this.clientType = clientType;
+        this.server = server;
     }
     // PactFlow AI client methods
-    async generate(body) {
+    /**
+     * Generate new Pact tests based on the provided input.
+     *
+     * @param toolInput The input data for the generation process.
+     * @param getInput Function to get additional input from the user if needed.
+     * @returns The result of the generation process.
+     * @throws Error if the HTTP request fails or the operation times out.
+     */
+    async generate(toolInput, getInput) {
+        if (toolInput.openapi?.document && (!toolInput.openapi?.matcher || Object.keys(toolInput.openapi.matcher).length === 0)) {
+            const matcherResponse = await getOADMatcherRecommendations(toolInput.openapi.document, this.server);
+            const userSelection = await getUserMatcherSelection(matcherResponse, getInput);
+            toolInput.openapi.matcher = userSelection;
+        }
         // Submit the generation request
         const response = await fetch(`${this.aiBaseUrl}/generate`, {
             method: "POST",
             headers: this.headers,
-            body: JSON.stringify(body),
+            body: JSON.stringify(toolInput),
         });
         if (!response.ok) {
-            throw new Error(`HTTP error! status: ${response.status}`);
+            throw new Error(`HTTP error! status: ${response.status} - ${await response.text()}`);
         }
         const status_response = await response.json();
         return await this.pollForCompletion(status_response, "Generation");
     }
-    async review(body) {
-        // submit review request
+    /**
+     * Review the provided Pact tests and suggest improvements.
+     *
+     * @param toolInput The input data for the review process.
+     * @param getInput Function to get additional input from the user if needed.
+     * @returns The result of the review process.
+     * @throws Error if the HTTP request fails or the operation times out.
+     */
+    async review(toolInput, getInput) {
+        if (toolInput.openapi?.document && (!toolInput.openapi?.matcher || Object.keys(toolInput.openapi.matcher).length === 0)) {
+            const matcherResponse = await getOADMatcherRecommendations(toolInput.openapi.document, this.server);
+            const userSelection = await getUserMatcherSelection(matcherResponse, getInput);
+            toolInput.openapi.matcher = userSelection;
+        }
+        // Submit review request
         const response = await fetch(`${this.aiBaseUrl}/review`, {
             method: "POST",
             headers: this.headers,
-            body: JSON.stringify(body),
+            body: JSON.stringify(toolInput),
         });
         if (!response.ok) {
-            throw new Error(`HTTP error! status: ${response.status}`);
+            throw new Error(`HTTP error! status: ${response.status} - ${await response.text()}`);
         }
         const status_response = await response.json();
         return await this.pollForCompletion(status_response, "Review Pacts");
     }
+    /**
+     * Retrieves AI status information for the current user
+     * and organization.
+     *
+     * @returns Entitlement containing AI status information, organization
+     *   entitlements, and user entitlements.
+     * @throws Error if the request fails or returns a non-OK response.
+     */
+    async getAIStatus() {
+        const url = `${this.aiBaseUrl}/entitlement`;
+        try {
+            const response = await fetch(url, {
+                method: "GET",
+                headers: this.headers,
+            });
+            if (!response.ok) {
+                const errorText = await response.text().catch(() => "");
+                throw new Error(`PactFlow AI Status Request Failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`);
+            }
+            return (await response.json());
+        }
+        catch (error) {
+            process.stderr.write(`[GetAICredits] Unexpected error: ${error}\n`);
+            throw error;
+        }
+    }
     async getStatus(statusUrl) {
         const response = await fetch(statusUrl, {
             method: "HEAD",
@@ -108,16 +172,121 @@ export class PactflowClient {
         }
         return response.json();
     }
-    registerTools(register, _getInput) {
+    /**
+     * Checks if a given pacticipant version is safe to deploy
+     * to a specified environment.
+     *
+     * @param body - Input containing:
+     *   - `pacticipant`: The name of the service (pacticipant).
+     *   - `version`: The version of the pacticipant being evaluated for deployment.
+     *   - `environment`: The target environment (e.g., staging, production).
+     * @returns CanIDeployResponse containing deployment decision and verification results.
+     * @throws Error if the request fails or returns a non-OK response.
+     */
+    async canIDeploy(body) {
+        const { pacticipant, version, environment } = body;
+        const queryParams = new URLSearchParams({
+            pacticipant,
+            version,
+            environment,
+        });
+        const url = `${this.baseUrl}/can-i-deploy?${queryParams.toString()}`;
+        try {
+            const response = await fetch(url, {
+                method: "GET",
+                headers: this.headers,
+            });
+            if (!response.ok) {
+                const errorText = await response.text().catch(() => "");
+                throw new Error(`Can-I-Deploy Request Failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`);
+            }
+            return (await response.json());
+        }
+        catch (error) {
+            console.error(`[CanIDeploy] Unexpected error: ${error}\n`);
+            throw error;
+        }
+    }
+    /**
+     * Retrieves the matrix of pact verification results for the specified pacticipants.
+     * This allows you to see which consumer/provider combinations have been verified
+     * and make deployment decisions based on contract test results.
+     *
+     * @param body - Matrix query parameters including pacticipants, versions, environments, etc.
+     * @returns MatrixResponse containing the verification matrix, notices, and summary
+     * @throws Error if the request fails or returns a non-OK response
+     */
+    async getMatrix(body) {
+        const { q, latestby, limit } = body;
+        // Build query parameters manually to avoid URL encoding of square brackets
+        const queryParts = [];
+        // Add optional parameters
+        if (latestby) {
+            queryParts.push(`latestby=${encodeURIComponent(latestby)}`);
+        }
+        if (limit !== undefined) {
+            queryParts.push(`limit=${limit}`);
+        }
+        // Add the q parameters (pacticipant selectors)
+        q.forEach((selector) => {
+            queryParts.push(`q[]pacticipant=${encodeURIComponent(selector.pacticipant)}`);
+            if (selector.version) {
+                queryParts.push(`q[]version=${encodeURIComponent(selector.version)}`);
+            }
+            if (selector.branch) {
+                queryParts.push(`q[]branch=${encodeURIComponent(selector.branch)}`);
+            }
+            if (selector.environment) {
+                queryParts.push(`q[]environment=${encodeURIComponent(selector.environment)}`);
+            }
+            if (selector.latest !== undefined) {
+                queryParts.push(`q[]latest=${selector.latest}`);
+            }
+            if (selector.tag) {
+                queryParts.push(`q[]tag=${encodeURIComponent(selector.tag)}`);
+            }
+            if (selector.mainBranch !== undefined) {
+                queryParts.push(`q[]mainBranch=${selector.mainBranch}`);
+            }
+        });
+        const url = `${this.baseUrl}/matrix?${queryParts.join('&')}`;
+        try {
+            const response = await fetch(url, {
+                method: "GET",
+                headers: this.headers,
+            });
+            if (!response.ok) {
+                const errorText = await response.text().catch(() => "");
+                throw new Error(`Matrix Request Failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`);
+            }
+            return (await response.json());
+        }
+        catch (error) {
+            console.error("[GetMatrix] Unexpected error:", error);
+            throw error;
+        }
+    }
+    /**
+     * Registers tools with the provided register function.
+     *
+     * @param register - The function used to register tools.
+     * @param getInput - The function used to get input for tools.
+     */
+    registerTools(register, getInput) {
         for (const tool of TOOLS.filter(t => t.clients.includes(this.clientType))) {
-            const { handler, clients, formatResponse, ...toolparams } = tool;
-            console.log(clients);
+            const { handler, clients: _, formatResponse, ...toolparams } = tool; // eslint-disable-line @typescript-eslint/no-unused-vars
             register(toolparams, async (args, _extra) => {
                 const handler_fn = this[handler];
                 if (typeof handler_fn !== "function") {
                     throw new Error(`Handler '${handler}' not found on PactClient`);
                 }
-                const result = await handler_fn.call(this, args);
+                let result;
+                if (tool.enableElicitation) {
+                    result = await handler_fn.call(this, args, getInput);
+                }
+                else {
+                    result = await handler_fn.call(this, args);
+                }
                 // Use custom response formatter if provided
                 if (formatResponse) {
                     return formatResponse(result);
@@ -129,4 +298,14 @@ export class PactflowClient {
             });
         }
     }
+    /**
+     * Registers prompts with the provided register function.
+     *
+     * @param register - The function used to register prompts.
+     */
+    registerPrompts(register) {
+        PROMPTS.forEach(prompt => {
+            register(prompt.name, prompt.params, prompt.callback);
+        });
+    }
 }

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@smartbear/mcp",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "MCP server for interacting SmartBear Products",
   "keywords": [
     "smartbear",
     "mcp",
-    "insight-hub",
+    "bugsnag",
     "reflect",
     "api-hub",
     "pactflow"
   ],
   "homepage": "https://developer.smartbear.com/smartbear-mcp",
+  "mcpName": "com.smartbear/smartbear-mcp",
   "repository": {
     "type": "git",
     "url": "git@github.com:SmartBear/smartbear-mcp.git"
@@ -44,10 +45,13 @@
     "@bugsnag/js": "^8.2.0",
     "@modelcontextprotocol/sdk": "^1.15.0",
     "node-cache": "^5.1.2",
-    "zod": "^3"
+    "swagger-client": "^3.35.6",
+    "zod": "^3",
+    "zod-to-json-schema": "^3.24.6"
   },
   "devDependencies": {
     "@eslint/js": "^9.29.0",
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^22",
     "@vitest/coverage-v8": "^3.2.4",
     "eslint": "^9.29.0",
@@ -55,6 +59,7 @@
     "shx": "^0.3.4",
     "typescript": "^5.6.2",
     "typescript-eslint": "^8.34.1",
-    "vitest": "^3.2.4"
+    "vitest": "^3.2.4",
+    "vitest-fetch-mock": "^0.4.5"
   }
 }

package/dist/insight-hub/client/api/Project.js

@@ -1,46 +0,0 @@
-import { BaseAPI, pickFieldsFromArray } from "./base.js";
-// --- API Class ---
-export class ProjectAPI extends BaseAPI {
-    static eventFieldFields = [
-        'custom',
-        'display_id',
-        'filter_options',
-        'pivot_options'
-    ];
-    constructor(configuration) {
-        super(configuration);
-    }
-    /**
-     * List the Event Fields for a Project
-     * GET /projects/{project_id}/event_fields
-     * @param projectId The project ID
-     * @returns A promise that resolves to the list of event fields
-     */
-    async listProjectEventFields(projectId) {
-        const url = `/projects/${projectId}/event_fields`;
-        const data = await this.request({
-            method: 'GET',
-            url,
-        });
-        // Only return allowed fields
-        return {
-            ...data,
-            body: pickFieldsFromArray(data.body || [], ProjectAPI.eventFieldFields)
-        };
-    }
-    /**
-     * Create a Project in an Organization
-     * POST /organizations/{organization_id}/projects
-     * @param organizationId The organization ID
-     * @param data The project creation request body
-     * @returns A promise that resolves to the created project
-     */
-    async createProject(organizationId, data) {
-        const url = `/organizations/${organizationId}/projects`;
-        return await this.request({
-            method: 'POST',
-            url,
-            body: data,
-        });
-    }
-}

package/dist/package.json

@@ -1,60 +0,0 @@
-{
-    "name": "@smartbear/mcp",
-    "version": "0.4.0",
-    "description": "MCP server for interacting SmartBear Products",
-    "keywords": [
-        "smartbear",
-        "mcp",
-        "insight-hub",
-        "reflect",
-        "api-hub",
-        "pactflow"
-    ],
-    "homepage": "https://developer.smartbear.com/smartbear-mcp",
-    "repository": {
-        "type": "git",
-        "url": "git@github.com:SmartBear/smartbear-mcp.git"
-    },
-    "license": "MIT",
-    "type": "module",
-    "bin": {
-        "mcp": "dist/index.js"
-    },
-    "files": [
-        "dist",
-        "assets",
-        "**/README.md"
-    ],
-    "config": {
-        "mcpServerName": "SmartBear MCP Server"
-    },
-    "scripts": {
-        "build": "tsc && shx chmod +x dist/*.js",
-        "lint": "eslint . --ext .ts",
-        "prepare": "npm run build",
-        "watch": "tsc --watch",
-        "test": "vitest",
-        "test:watch": "vitest --watch",
-        "test:coverage": "vitest --coverage",
-        "test:coverage:ci": "vitest --coverage --reporter=verbose",
-        "test:run": "vitest run",
-        "coverage:check": "vitest --coverage --reporter=verbose --config vitest.config.coverage.ts"
-    },
-    "dependencies": {
-        "@bugsnag/js": "^8.2.0",
-        "@modelcontextprotocol/sdk": "^1.15.0",
-        "node-cache": "^5.1.2",
-        "zod": "^3"
-    },
-    "devDependencies": {
-        "@eslint/js": "^9.29.0",
-        "@types/node": "^22",
-        "@vitest/coverage-v8": "^3.2.4",
-        "eslint": "^9.29.0",
-        "globals": "^16.2.0",
-        "shx": "^0.3.4",
-        "typescript": "^5.6.2",
-        "typescript-eslint": "^8.34.1",
-        "vitest": "^3.2.4"
-    }
-}