@smartbear/mcp 0.10.0 → 0.11.0

package/dist/reflect/client.js

@@ -1,17 +1,23 @@
 import { z } from "zod";
 import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
 import { ToolError, } from "../common/types.js";
+const ConfigurationSchema = z.object({
+    api_token: z.string().describe("Reflect API authentication token"),
+});
 // ReflectClient class implementing the Client interface
 export class ReflectClient {
-    headers;
+    headers = {};
     name = "Reflect";
-    prefix = "reflect";
-    constructor(token) {
+    toolPrefix = "reflect";
+    configPrefix = "Reflect";
+    config = ConfigurationSchema;
+    async configure(_server, config, _cache) {
         this.headers = {
-            "X-API-KEY": `${token}`,
+            "X-API-KEY": `${config.api_token}`,
             "Content-Type": "application/json",
             "User-Agent": `${MCP_SERVER_NAME}/${MCP_SERVER_VERSION}`,
         };
+        return true;
     }
     async listReflectSuites() {
         const response = await fetch("https://api.reflect.run/v1/suites", {

package/dist/{api-hub → swagger}/client/api.js

@@ -7,7 +7,7 @@ import { ToolError } from "../../common/types.js";
 //   - group 3: name
 //   - group 4: version
 const SWAGGER_URL_REGEX = /\/(apis|domains|templates)\/([^/]+)\/([^/]+)\/([^/]+)/;
-export class ApiHubAPI {
+export class SwaggerAPI {
     config;
     headers;
     constructor(config, userAgent) {
@@ -141,7 +141,7 @@ export class ApiHubAPI {
         });
         if (!response.ok) {
             const errorText = await response.text().catch(() => "");
-            throw new ToolError(`API Hub deletePortal failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`);
+            throw new ToolError(`Swagger deletePortal failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`);
         }
     }
     async updatePortal(portalId, body) {

package/dist/{api-hub → swagger}/client/configuration.js

@@ -1,4 +1,4 @@
-export class ApiHubConfiguration {
+export class SwaggerConfiguration {
     token;
     portalBasePath;
     registryBasePath;

package/dist/{api-hub → swagger}/client/index.js

@@ -1,5 +1,5 @@
-export { ApiHubAPI } from "./api.js";
-export { ApiHubConfiguration, } from "./configuration.js";
+export { SwaggerAPI } from "./api.js";
+export { SwaggerConfiguration, } from "./configuration.js";
 export * from "./portal-types.js";
 export * from "./registry-types.js";
 export { TOOLS } from "./tools.js";

package/dist/{api-hub → swagger}/client/tools.js

@@ -1,7 +1,7 @@
 /**
  * TOOLS
  *
- * Defines tool configurations for API Hub operations.
+ * Defines tool configurations for Swagger operations.
  * Each tool includes parameters, descriptions, and handler method names.
  * This follows the pattern established in the pactflow module.
  */
@@ -11,13 +11,13 @@ import { OrganizationsQuerySchema } from "./user-management-types.js";
 export const TOOLS = [
     {
         title: "List Portals",
-        summary: "Search for available portals within API Hub. Only portals where you have at least a designer role, either at the product level or organization level, are returned.",
+        summary: "Search for available portals within Swagger. Only portals where you have at least a designer role, either at the product level or organization level, are returned.",
         parameters: [],
         handler: "getPortals",
     },
     {
         title: "Create Portal",
-        summary: "Create a new portal within API Hub.",
+        summary: "Create a new portal within Swagger.",
         inputSchema: CreatePortalArgsSchema,
         handler: "createPortal",
     },
@@ -135,7 +135,7 @@ export const TOOLS = [
     },
     {
         title: "Create or Update API",
-        summary: "Create a new API or update an existing API in SwaggerHub Registry for API Hub for Design. The API specification type (OpenAPI, AsyncAPI) is automatically detected from the definition content. APIs are always created with fixed values: version 1.0.0, private visibility, and automock disabled (these values cannot be changed). Returns HTTP 201 for creation, HTTP 200 for update. Response includes 'operation' field indicating whether it was a 'create' or 'update' operation along with API details and SwaggerHub URL.",
+        summary: "Create a new API or update an existing API in SwaggerHub Registry for Swagger Studio. The API specification type (OpenAPI, AsyncAPI) is automatically detected from the definition content. APIs are always created with fixed values: version 1.0.0, private visibility, and automock disabled (these values cannot be changed). Returns HTTP 201 for creation, HTTP 200 for update. Response includes 'operation' field indicating whether it was a 'create' or 'update' operation along with API details and SwaggerHub URL.",
         inputSchema: CreateApiParamsSchema,
         handler: "createOrUpdateApi",
     },

package/dist/{api-hub → swagger}/client.js

@@ -1,95 +1,107 @@
+import { z } from "zod";
 import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
-import { ApiHubAPI, ApiHubConfiguration, TOOLS, } from "./client/index.js";
+// Apply backward compatibility for API_HUB_API_KEY
+import "./config-utils.js";
+import { SwaggerAPI, SwaggerConfiguration, TOOLS, } from "./client/index.js";
+const ConfigurationSchema = z.object({
+    api_key: z.string().describe("Swagger API key for authentication"),
+});
 // Tool definitions for API Hub API client
-export class ApiHubClient {
-    config;
+export class SwaggerClient {
     api;
-    name = "API Hub";
-    prefix = "api_hub";
-    constructor(token) {
-        this.config = new ApiHubConfiguration({ token });
-        this.api = new ApiHubAPI(this.config, `${MCP_SERVER_NAME}/${MCP_SERVER_VERSION}`);
-    }
-    // Delegate API methods to the ApiHubAPI instance
+    name = "Swagger";
+    toolPrefix = "swagger";
+    configPrefix = "Swagger";
+    config = ConfigurationSchema;
+    async configure(_server, config, _cache) {
+        this.api = new SwaggerAPI(new SwaggerConfiguration({ token: config.api_key }), `${MCP_SERVER_NAME}/${MCP_SERVER_VERSION}`);
+        return true;
+    }
+    getApi() {
+        if (!this.api)
+            throw new Error("Client not configured");
+        return this.api;
+    }
+    // Delegate API methods to the SwaggerAPI instance
     async getPortals() {
-        return this.api.getPortals();
+        return this.getApi().getPortals();
     }
     async createPortal(body) {
-        return this.api.createPortal(body);
+        return this.getApi().createPortal(body);
     }
     async getPortal(args) {
-        return this.api.getPortal(args.portalId);
+        return this.getApi().getPortal(args.portalId);
     }
     async deletePortal(args) {
-        return this.api.deletePortal(args.portalId);
+        return this.getApi().deletePortal(args.portalId);
     }
     async updatePortal(args) {
         const { portalId, ...body } = args;
-        return this.api.updatePortal(portalId, body);
+        return this.getApi().updatePortal(portalId, body);
     }
     async getPortalProducts(args) {
-        return this.api.getPortalProducts(args.portalId);
+        return this.getApi().getPortalProducts(args.portalId);
     }
     async createPortalProduct(args) {
         const { portalId, ...body } = args;
-        return this.api.createPortalProduct(portalId, body);
+        return this.getApi().createPortalProduct(portalId, body);
     }
     async getPortalProduct(args) {
-        return this.api.getPortalProduct(args.productId);
+        return this.getApi().getPortalProduct(args.productId);
     }
     async deletePortalProduct(args) {
-        return this.api.deletePortalProduct(args.productId);
+        return this.getApi().deletePortalProduct(args.productId);
     }
     async updatePortalProduct(args) {
         const { productId, ...body } = args;
-        return this.api.updatePortalProduct(productId, body);
+        return this.getApi().updatePortalProduct(productId, body);
     }
     async publishPortalProduct(args) {
         const { productId, preview } = args;
-        return this.api.publishPortalProduct(productId, preview);
+        return this.getApi().publishPortalProduct(productId, preview);
     }
     async getPortalProductSections(args) {
         const { productId, ...params } = args;
-        return this.api.getPortalProductSections(productId, params);
+        return this.getApi().getPortalProductSections(productId, params);
     }
     async createTableOfContents(args) {
         const { sectionId, ...body } = args;
-        return this.api.createTableOfContents(sectionId, body);
+        return this.getApi().createTableOfContents(sectionId, body);
     }
     async getTableOfContents(args) {
-        return this.api.getTableOfContents(args);
+        return this.getApi().getTableOfContents(args);
     }
     async getDocument(args) {
-        return this.api.getDocument(args);
+        return this.getApi().getDocument(args);
     }
     async updateDocument(args) {
-        return this.api.updateDocument(args);
+        return this.getApi().updateDocument(args);
     }
     async deleteDocument(args) {
-        return this.api.deleteDocument(args);
+        return this.getApi().deleteDocument(args);
     }
     async deleteTableOfContents(args) {
-        return this.api.deleteTableOfContents(args);
+        return this.getApi().deleteTableOfContents(args);
     }
     // Registry API methods for SwaggerHub Design functionality
     async searchApis(args = {}) {
-        return this.api.searchApis(args);
+        return this.getApi().searchApis(args);
     }
     async getApiDefinition(args) {
-        return this.api.getApiDefinition(args);
+        return this.getApi().getApiDefinition(args);
     }
     async createOrUpdateApi(args) {
-        return this.api.createOrUpdateApi(args);
+        return this.getApi().createOrUpdateApi(args);
     }
     async createApiFromTemplate(args) {
-        return this.api.createApiFromTemplate(args);
+        return this.getApi().createApiFromTemplate(args);
     }
     // User Management API methods
     async getOrganizations(args) {
-        return this.api.getOrganizations(args);
+        return this.getApi().getOrganizations(args);
     }
     async scanStandardization(args) {
-        return this.api.scanStandardization(args);
+        return this.getApi().scanStandardization(args);
     }
     registerTools(register, _getInput) {
         TOOLS.forEach((tool) => {
@@ -99,7 +111,7 @@ export class ApiHubClient {
                     // Dynamic method invocation
                     const handlerFn = this[handler];
                     if (typeof handlerFn !== "function") {
-                        throw new Error(`Handler '${handler}' not found on ApiHubClient`);
+                        throw new Error(`Handler '${handler}' not found on SwaggerClient`);
                     }
                     const result = await handlerFn.call(this, args);
                     // Use custom formatter if available, otherwise return JSON

package/dist/swagger/config-utils.js

@@ -0,0 +1,18 @@
+/**
+ * Configuration utilities for Swagger client
+ * Handles backward compatibility with legacy environment variables
+ */
+/**
+ * Apply API_HUB_API_KEY fallback to SWAGGER_API_KEY if needed
+ * This modifies process.env to enable backward compatibility
+ * @deprecated API_HUB_API_KEY support - TODO: Remove after migration period (May 2026)
+ */
+export function applySwaggerApiKeyFallback() {
+    // If SWAGGER_API_KEY is not set but API_HUB_API_KEY is, use the legacy variable
+    if (!process.env.SWAGGER_API_KEY && process.env.API_HUB_API_KEY) {
+        console.warn("[Swagger] API_HUB_API_KEY is deprecated. Please use SWAGGER_API_KEY instead.");
+        process.env.SWAGGER_API_KEY = process.env.API_HUB_API_KEY;
+    }
+}
+// Apply the fallback immediately when this module is imported
+applySwaggerApiKeyFallback();

package/dist/zephyr/client.js

@@ -1,22 +1,54 @@
+import z from "zod";
 import { ApiClient } from "./common/api-client.js";
+import { GetPriorities } from "./tool/priority/get-priorities.js";
 import { GetProject } from "./tool/project/get-project.js";
 import { GetProjects } from "./tool/project/get-projects.js";
+import { GetStatuses } from "./tool/status/get-statuses.js";
+import { GetTestCase } from "./tool/test-case/get-test-case.js";
+import { GetTestCases } from "./tool/test-case/get-test-cases.js";
+import { GetTestCycle } from "./tool/test-cycle/get-test-cycle.js";
 import { GetTestCycles } from "./tool/test-cycle/get-test-cycles.js";
+import { GetTestExecution } from "./tool/test-execution/get-test-execution.js";
+const BASE_URL_DEFAULT = "https://api.zephyrscale.smartbear.com/v2";
+const ConfigurationSchema = z.object({
+    api_token: z.string().describe("Zephyr Scale API token for authentication"),
+    base_url: z
+        .string()
+        .url()
+        .optional()
+        .describe("Zephyr Scale API base URL")
+        .default(BASE_URL_DEFAULT),
+});
 export class ZephyrClient {
     apiClient;
     name = "Zephyr";
-    prefix = "zephyr";
-    constructor(bearerToken, baseUrl = "https://api.zephyrscale.smartbear.com/v2") {
-        this.apiClient = new ApiClient(bearerToken, baseUrl);
+    toolPrefix = "zephyr";
+    configPrefix = "Zephyr";
+    config = ConfigurationSchema;
+    async configure(_server, config, _cache) {
+        this.apiClient = new ApiClient(config.api_token, config.base_url || BASE_URL_DEFAULT);
+        return true;
+    }
+    getApiClient() {
+        if (!this.apiClient)
+            throw new Error("Client not configured");
+        return this.apiClient;
     }
     registerTools(register, _getInput) {
+        const apiClient = this.getApiClient();
         const tools = [
-            new GetProjects(this.apiClient),
-            new GetProject(this.apiClient),
-            new GetTestCycles(this.apiClient),
+            new GetProjects(apiClient),
+            new GetProject(apiClient),
+            new GetTestCycles(apiClient),
+            new GetTestCycle(apiClient),
+            new GetPriorities(apiClient),
+            new GetStatuses(apiClient),
+            new GetTestCases(apiClient),
+            new GetTestCase(apiClient),
+            new GetTestExecution(apiClient),
         ];
-        tools.forEach((tool) => {
+        for (const tool of tools) {
             register(tool.specification, tool.handle);
-        });
+        }
     }
 }