@smartbear/mcp 0.12.0 → 0.13.1

package/dist/swagger/client.js

@@ -1,141 +1,149 @@
 import { z } from "zod";
 import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
-// Apply backward compatibility for API_HUB_API_KEY
 import "./config-utils.js";
-import { SwaggerAPI, SwaggerConfiguration, TOOLS, } from "./client/index.js";
+import { SwaggerAPI } from "./client/api.js";
+import { SwaggerConfiguration } from "./client/configuration.js";
+import "./client/portal-types.js";
+import "./client/registry-types.js";
+import { TOOLS } from "./client/tools.js";
+import "./client/user-management-types.js";
 const ConfigurationSchema = z.object({
-    api_key: z.string().describe("Swagger API key for authentication"),
+  api_key: z.string().describe("Swagger API key for authentication"),
+  portal_base_path: z.string().optional().describe("Base path for Portal API requests (optional)"),
+  registry_base_path: z.string().optional().describe("Base path for Registry API requests (optional)"),
+  ui_base_path: z.string().optional().describe("Base URL for the SwaggerHub UI (optional)")
 });
-// Tool definitions for API Hub API client
-export class SwaggerClient {
-    api;
-    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.getApi().getPortals();
-    }
-    async createPortal(body) {
-        return this.getApi().createPortal(body);
-    }
-    async getPortal(args) {
-        return this.getApi().getPortal(args.portalId);
-    }
-    async updatePortal(args) {
-        const { portalId, ...body } = args;
-        return this.getApi().updatePortal(portalId, body);
-    }
-    async getPortalProducts(args) {
-        return this.getApi().getPortalProducts(args.portalId);
-    }
-    async createPortalProduct(args) {
-        const { portalId, ...body } = args;
-        return this.getApi().createPortalProduct(portalId, body);
-    }
-    async getPortalProduct(args) {
-        return this.getApi().getPortalProduct(args.productId);
-    }
-    async deletePortalProduct(args) {
-        return this.getApi().deletePortalProduct(args.productId);
-    }
-    async updatePortalProduct(args) {
-        const { productId, ...body } = args;
-        return this.getApi().updatePortalProduct(productId, body);
-    }
-    async publishPortalProduct(args) {
-        const { productId, preview } = args;
-        return this.getApi().publishPortalProduct(productId, preview);
-    }
-    async getPortalProductSections(args) {
-        const { productId, ...params } = args;
-        return this.getApi().getPortalProductSections(productId, params);
-    }
-    async createTableOfContents(args) {
-        const { sectionId, ...body } = args;
-        return this.getApi().createTableOfContents(sectionId, body);
-    }
-    async getTableOfContents(args) {
-        return this.getApi().getTableOfContents(args);
-    }
-    async getDocument(args) {
-        return this.getApi().getDocument(args);
-    }
-    async updateDocument(args) {
-        return this.getApi().updateDocument(args);
-    }
-    async deleteTableOfContents(args) {
-        return this.getApi().deleteTableOfContents(args);
-    }
-    // Registry API methods for SwaggerHub Design functionality
-    async searchApis(args = {}) {
-        return this.getApi().searchApis(args);
-    }
-    async getApiDefinition(args) {
-        return this.getApi().getApiDefinition(args);
-    }
-    async createOrUpdateApi(args) {
-        return this.getApi().createOrUpdateApi(args);
-    }
-    async createApiFromTemplate(args) {
-        return this.getApi().createApiFromTemplate(args);
-    }
-    // User Management API methods
-    async getOrganizations(args) {
-        return this.getApi().getOrganizations(args);
-    }
-    async createApiFromPrompt(args) {
-        return this.getApi().createApiFromPrompt(args);
-    }
-    async scanStandardization(args) {
-        return this.getApi().scanStandardization(args);
-    }
-    async standardizeApi(args) {
-        return this.getApi().standardizeApi(args);
-    }
-    registerTools(register, _getInput) {
-        TOOLS.forEach((tool) => {
-            const { handler, formatResponse, ...toolParams } = tool;
-            register(toolParams, async (args, _extra) => {
-                try {
-                    // Dynamic method invocation
-                    const handlerFn = this[handler];
-                    if (typeof handlerFn !== "function") {
-                        throw new Error(`Handler '${handler}' not found on SwaggerClient`);
-                    }
-                    const result = await handlerFn.call(this, args);
-                    // Use custom formatter if available, otherwise return JSON
-                    const formattedResult = formatResponse
-                        ? formatResponse(result)
-                        : result;
-                    const responseText = typeof formattedResult === "string"
-                        ? formattedResult
-                        : JSON.stringify(formattedResult);
-                    return {
-                        content: [{ type: "text", text: responseText }],
-                    };
-                }
-                catch (error) {
-                    return {
-                        content: [
-                            {
-                                type: "text",
-                                text: `Error: ${error instanceof Error ? error.message : String(error)}`,
-                            },
-                        ],
-                    };
-                }
-            });
-        });
-    }
+class SwaggerClient {
+  api;
+  name = "Swagger";
+  toolPrefix = "swagger";
+  configPrefix = "Swagger";
+  config = ConfigurationSchema;
+  async configure(_server, config, _cache) {
+    this.api = new SwaggerAPI(
+      new SwaggerConfiguration({
+        token: config.api_key,
+        portalBasePath: config.portal_base_path,
+        registryBasePath: config.registry_base_path,
+        uiBasePath: config.ui_base_path
+      }),
+      `${MCP_SERVER_NAME}/${MCP_SERVER_VERSION}`
+    );
+  }
+  isConfigured() {
+    return this.api !== void 0;
+  }
+  getApi() {
+    if (!this.api) throw new Error("Client not configured");
+    return this.api;
+  }
+  // Delegate API methods to the SwaggerAPI instance
+  async getPortals() {
+    return this.getApi().getPortals();
+  }
+  async createPortal(body) {
+    return this.getApi().createPortal(body);
+  }
+  async getPortal(args) {
+    return this.getApi().getPortal(args.portalId);
+  }
+  async updatePortal(args) {
+    const { portalId, ...body } = args;
+    return this.getApi().updatePortal(portalId, body);
+  }
+  async getPortalProducts(args) {
+    return this.getApi().getPortalProducts(args.portalId);
+  }
+  async createPortalProduct(args) {
+    const { portalId, ...body } = args;
+    return this.getApi().createPortalProduct(portalId, body);
+  }
+  async getPortalProduct(args) {
+    return this.getApi().getPortalProduct(args.productId);
+  }
+  async deletePortalProduct(args) {
+    return this.getApi().deletePortalProduct(args.productId);
+  }
+  async updatePortalProduct(args) {
+    const { productId, ...body } = args;
+    return this.getApi().updatePortalProduct(productId, body);
+  }
+  async publishPortalProduct(args) {
+    const { productId, preview } = args;
+    return this.getApi().publishPortalProduct(productId, preview);
+  }
+  async getPortalProductSections(args) {
+    const { productId, ...params } = args;
+    return this.getApi().getPortalProductSections(productId, params);
+  }
+  async createTableOfContents(args) {
+    const { sectionId, ...body } = args;
+    return this.getApi().createTableOfContents(sectionId, body);
+  }
+  async getTableOfContents(args) {
+    return this.getApi().getTableOfContents(args);
+  }
+  async getDocument(args) {
+    return this.getApi().getDocument(args);
+  }
+  async updateDocument(args) {
+    return this.getApi().updateDocument(args);
+  }
+  async deleteTableOfContents(args) {
+    return this.getApi().deleteTableOfContents(args);
+  }
+  // Registry API methods for SwaggerHub Design functionality
+  async searchApis(args = {}) {
+    return this.getApi().searchApis(args);
+  }
+  async getApiDefinition(args) {
+    return this.getApi().getApiDefinition(args);
+  }
+  async createOrUpdateApi(args) {
+    return this.getApi().createOrUpdateApi(args);
+  }
+  // User Management API methods
+  async getOrganizations(args) {
+    return this.getApi().getOrganizations(args);
+  }
+  async createApiFromPrompt(args) {
+    return this.getApi().createApiFromPrompt(args);
+  }
+  async scanStandardization(args) {
+    return this.getApi().scanStandardization(args);
+  }
+  async standardizeApi(args) {
+    return this.getApi().standardizeApi(args);
+  }
+  async registerTools(register, _getInput) {
+    TOOLS.forEach((tool) => {
+      const { handler, formatResponse, ...toolParams } = tool;
+      register(toolParams, async (args, _extra) => {
+        try {
+          const handlerFn = this[handler];
+          if (typeof handlerFn !== "function") {
+            throw new Error(`Handler '${handler}' not found on SwaggerClient`);
+          }
+          const result = await handlerFn.call(this, args);
+          const formattedResult = formatResponse ? formatResponse(result) : result;
+          const responseText = typeof formattedResult === "string" ? formattedResult : JSON.stringify(formattedResult);
+          return {
+            content: [{ type: "text", text: responseText }]
+          };
+        } catch (error) {
+          return {
+            content: [
+              {
+                type: "text",
+                text: `Error: ${error instanceof Error ? error.message : String(error)}`
+              }
+            ]
+          };
+        }
+      });
+    });
+  }
 }
+export {
+  SwaggerClient
+};

package/dist/swagger/config-utils.js

@@ -1,18 +1,12 @@
-/**
- * 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;
-    }
+function applySwaggerApiKeyFallback() {
+  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();
+export {
+  applySwaggerApiKeyFallback
+};

package/dist/zephyr/client.js

@@ -1,4 +1,4 @@
-import z from "zod";
+import zod__default from "zod";
 import { ApiClient } from "./common/api-client.js";
 import { GetEnvironments } from "./tool/environment/get-environments.js";
 import { GetPriorities } from "./tool/priority/get-priorities.js";
@@ -12,47 +12,48 @@ import { GetTestCycles } from "./tool/test-cycle/get-test-cycles.js";
 import { GetTestExecution } from "./tool/test-execution/get-test-execution.js";
 import { GetTestExecutions } from "./tool/test-execution/get-test-executions.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),
+const ConfigurationSchema = zod__default.object({
+  api_token: zod__default.string().describe("Zephyr Scale API token for authentication"),
+  base_url: zod__default.string().url().optional().describe("Zephyr Scale API base URL").default(BASE_URL_DEFAULT)
 });
-export class ZephyrClient {
-    apiClient;
-    name = "Zephyr";
-    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(apiClient),
-            new GetProject(apiClient),
-            new GetTestCycles(apiClient),
-            new GetTestCycle(apiClient),
-            new GetPriorities(apiClient),
-            new GetStatuses(apiClient),
-            new GetTestCases(apiClient),
-            new GetEnvironments(apiClient),
-            new GetTestCase(apiClient),
-            new GetTestExecution(apiClient),
-            new GetTestExecutions(apiClient),
-        ];
-        for (const tool of tools) {
-            register(tool.specification, tool.handle);
-        }
+class ZephyrClient {
+  apiClient;
+  name = "Zephyr";
+  toolPrefix = "zephyr";
+  configPrefix = "Zephyr";
+  config = ConfigurationSchema;
+  async configure(_server, config, _cache) {
+    this.apiClient = new ApiClient(
+      config.api_token,
+      config.base_url || BASE_URL_DEFAULT
+    );
+  }
+  isConfigured() {
+    return this.apiClient !== void 0;
+  }
+  getApiClient() {
+    if (!this.apiClient) throw new Error("Client not configured");
+    return this.apiClient;
+  }
+  async registerTools(register, _getInput) {
+    const tools = [
+      new GetProjects(this),
+      new GetProject(this),
+      new GetTestCycles(this),
+      new GetTestCycle(this),
+      new GetPriorities(this),
+      new GetStatuses(this),
+      new GetTestCases(this),
+      new GetEnvironments(this),
+      new GetTestCase(this),
+      new GetTestExecution(this),
+      new GetTestExecutions(this)
+    ];
+    for (const tool of tools) {
+      register(tool.specification, tool.handle);
     }
+  }
 }
+export {
+  ZephyrClient
+};

package/dist/zephyr/common/api-client.js

@@ -1,35 +1,40 @@
-import { ToolError } from "../../common/types.js";
+import { ToolError } from "../../common/tools.js";
 import { AuthService } from "./auth-service.js";
-export class ApiClient {
-    baseUrl;
-    defaultHeaders;
-    constructor(bearerToken, baseUrl) {
-        this.baseUrl = baseUrl.trim().replace(/\/$/, "");
-        this.defaultHeaders = new AuthService(bearerToken).getAuthHeaders();
-    }
-    getUrl(endpoint, params) {
-        const url = new URL(this.baseUrl + endpoint);
-        if (params) {
-            Object.entries(params).forEach(([key, value]) => {
-                if (value !== undefined) {
-                    url.searchParams.append(key, String(value));
-                }
-            });
+class ApiClient {
+  baseUrl;
+  defaultHeaders;
+  constructor(bearerToken, baseUrl) {
+    this.baseUrl = baseUrl.trim().replace(/\/$/, "");
+    this.defaultHeaders = new AuthService(bearerToken).getAuthHeaders();
+  }
+  getUrl(endpoint, params) {
+    const url = new URL(this.baseUrl + endpoint);
+    if (params) {
+      Object.entries(params).forEach(([key, value]) => {
+        if (value !== void 0) {
+          url.searchParams.append(key, String(value));
         }
-        return url.toString();
-    }
-    async get(endpoint, params) {
-        const response = await fetch(this.getUrl(endpoint, params), {
-            method: "GET",
-            headers: this.defaultHeaders,
-        });
-        return await this.validateAndGetResponseBody(response);
+      });
     }
-    async validateAndGetResponseBody(response) {
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new ToolError(`Request failed with status ${response.status}: ${errorText}`);
-        }
-        return response.json();
+    return url.toString();
+  }
+  async get(endpoint, params) {
+    const response = await fetch(this.getUrl(endpoint, params), {
+      method: "GET",
+      headers: this.defaultHeaders
+    });
+    return await this.validateAndGetResponseBody(response);
+  }
+  async validateAndGetResponseBody(response) {
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new ToolError(
+        `Request failed with status ${response.status}: ${errorText}`
+      );
     }
+    return response.json();
+  }
 }
+export {
+  ApiClient
+};

package/dist/zephyr/common/auth-service.js

@@ -1,15 +1,18 @@
 import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../../common/info.js";
-export class AuthService {
-    bearerToken;
-    constructor(accessToken) {
-        this.bearerToken = accessToken.trim();
-    }
-    getAuthHeaders() {
-        return {
-            Authorization: `Bearer ${this.bearerToken}`,
-            "Content-Type": "application/json",
-            "User-Agent": `${MCP_SERVER_NAME}/${MCP_SERVER_VERSION}`,
-            "zscale-source": "smartbear-mcp",
-        };
-    }
+class AuthService {
+  bearerToken;
+  constructor(accessToken) {
+    this.bearerToken = accessToken.trim();
+  }
+  getAuthHeaders() {
+    return {
+      Authorization: `Bearer ${this.bearerToken}`,
+      "Content-Type": "application/json",
+      "User-Agent": `${MCP_SERVER_NAME}/${MCP_SERVER_VERSION}`,
+      "zscale-source": "smartbear-mcp"
+    };
+  }
 }
+export {
+  AuthService
+};