@smartbear/mcp 0.7.0 → 0.9.0

package/README.md

@@ -18,7 +18,7 @@
 </div>
 <br />
 
-A Model Context Protocol (MCP) server which provides AI assistants with seamless access to SmartBear's suite of testing and monitoring tools, including [BugSnag](https://www.bugsnag.com/), [Reflect](https://reflect.run), [API Hub](https://www.smartbear.com/api-hub), [PactFlow](https://pactflow.io/), [Pact Broker](https://docs.pact.io/), and [QMetry](https://www.qmetry.com/)
+A Model Context Protocol (MCP) server which provides AI assistants with seamless access to SmartBear's suite of testing and monitoring tools, including [BugSnag](https://www.bugsnag.com/), [Reflect](https://reflect.run), [API Hub](https://www.smartbear.com/api-hub), [PactFlow](https://pactflow.io/), [Pact Broker](https://docs.pact.io/), [QMetry](https://www.qmetry.com/), and [Zephyr](https://smartbear.com/test-management/zephyr/).
 
 ## What is MCP?
 
@@ -33,12 +33,13 @@ See individual guides for suggested prompts and supported tools and resources:
 - [API Hub](https://developer.smartbear.com/smartbear-mcp/docs/api-hub-integration) - Portal management capabilities
 - [PactFlow](https://developer.smartbear.com/pactflow/default/getting-started) - Contract testing capabilities
 - [QMetry](https://developer.smartbear.com/smartbear-mcp/docs/qmetry-integration) - QMetry Test Management capabilities
+- [Zephyr](https://developer.smartbear.com/smartbear-mcp/docs/zephyr-integration) - Zephyr Test Management capabilities
 
 
 ## Prerequisites
 
 - Node.js 20+ and npm
-- Access to SmartBear products (BugSnag, Reflect, API Hub, or QMetry)
+- Access to SmartBear products (BugSnag, Reflect, API Hub, QMetry, or Zephyr)
 - Valid API tokens for the products you want to integrate
 
 ## Installation
@@ -77,6 +78,8 @@ Alternatively, you can use `npx` (or globally install) the `@smartbear/mcp` pack
         "PACT_BROKER_PASSWORD": "${input:pact_broker_password}",
         "QMETRY_API_KEY": "${input:qmetry_api_key}",
         "QMETRY_BASE_URL": "${input:qmetry_base_url}",
+        "ZEPHYR_API_TOKEN": "${input:zephyr_api_token}",
+        "ZEPHYR_BASE_URL": "${input:zephyr_base_url}"
       }
     }
   },
@@ -141,6 +144,18 @@ Alternatively, you can use `npx` (or globally install) the `@smartbear/mcp` pack
           "description": "By default, connects to https://testmanagement.qmetry.com. Change to a custom QMetry server URL or a region-specific endpoint if needed.",
           "password": false
       },
+      {
+          "id": "zephyr_api_token",
+          "type": "promptString",
+          "description": "Zephyr API token - leave blank to disable Zephyr tools",
+          "password": true
+      },
+      {
+          "id": "zephyr_base_url",
+          "type": "promptString",
+          "description": "Zephyr API base URL. By default, connects to https://api.zephyrscale.smartbear.com/v2. Change to region-specific endpoint if needed.",
+          "password": false
+      }
   ]
 }
 ```
@@ -170,6 +185,8 @@ Add the following configuration to your `claude_desktop_config.json` to launch t
         "PACT_BROKER_PASSWORD": "your_pact_broker_password",
         "QMETRY_API_KEY": "your_qmetry_api_key",
         "QMETRY_BASE_URL": "https://testmanagement.qmetry.com",
+        "ZEPHYR_API_TOKEN": "your_zephyr_api_token",
+        "ZEPHYR_BASE_URL": "https://api.zephyrscale.smartbear.com/v2"
       }
     }
   }

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

@@ -1,3 +1,4 @@
+import { ToolError } from "../../common/types.js";
 // Regex to extract owner, name, and version from SwaggerHub URLs.
 // Matches /apis/owner/name/version, /domains/owner/name/version, or /templates/owner/name/version
 // Example: /apis/acme/petstore/1.0.0
@@ -39,13 +40,26 @@ export class ApiHubAPI {
                 return (await response.json());
             }
             catch (error) {
-                console.warn("Failed to parse JSON response:", error);
+                console.warn("Failed to parse JSON response (declared JSON):", error);
                 return defaultReturn;
             }
         }
-        // Fallback for non-JSON responses
+        // Fallback: read text and attempt heuristic JSON parse
         const text = await response.text();
-        return text ? { message: text } : defaultReturn;
+        if (!text)
+            return defaultReturn;
+        const trimmed = text.trim();
+        const firstChar = trimmed[0];
+        if (firstChar === "{" || firstChar === "[") {
+            try {
+                return JSON.parse(trimmed);
+            }
+            catch (error) {
+                console.warn("Heuristic JSON parse failed:", error);
+                return { message: text };
+            }
+        }
+        return { message: text };
     }
     /**
      * Handles HTTP responses with smart JSON parsing and fallback handling.
@@ -57,7 +71,7 @@ export class ApiHubAPI {
      */
     async handleResponse(response, defaultReturn = {}) {
         if (!response.ok) {
-            throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+            throw new ToolError(`HTTP ${response.status}: ${response.statusText}`);
         }
         return this.parseResponse(response, defaultReturn);
     }
@@ -66,7 +80,8 @@ export class ApiHubAPI {
             method: "GET",
             headers: this.headers,
         });
-        return response.json();
+        const result = await this.handleResponse(response, []);
+        return result;
     }
     async createPortal(body) {
         const response = await fetch(`${this.config.portalBasePath}/portals`, {
@@ -74,20 +89,32 @@ export class ApiHubAPI {
             headers: this.headers,
             body: JSON.stringify(body),
         });
-        return response.json();
+        const result = await this.handleResponse(response);
+        if (!("id" in result)) {
+            throw new Error("Unexpected empty response creating portal");
+        }
+        return result;
     }
     async getPortal(portalId) {
         const response = await fetch(`${this.config.portalBasePath}/portals/${portalId}`, {
             method: "GET",
             headers: this.headers,
         });
-        return response.json();
+        const result = await this.handleResponse(response);
+        if (!("id" in result)) {
+            throw new ToolError("Portal not found or empty response");
+        }
+        return result;
     }
     async deletePortal(portalId) {
-        await fetch(`${this.config.portalBasePath}/portals/${portalId}`, {
+        const response = await fetch(`${this.config.portalBasePath}/portals/${portalId}`, {
             method: "DELETE",
             headers: this.headers,
         });
+        if (!response.ok) {
+            const errorText = await response.text().catch(() => "");
+            throw new ToolError(`API Hub deletePortal failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`);
+        }
     }
     async updatePortal(portalId, body) {
         const response = await fetch(`${this.config.portalBasePath}/portals/${portalId}`, {
@@ -102,7 +129,8 @@ export class ApiHubAPI {
             method: "GET",
             headers: this.headers,
         });
-        return response.json();
+        const result = await this.handleResponse(response, []);
+        return result;
     }
     async createPortalProduct(portalId, body) {
         const response = await fetch(`${this.config.portalBasePath}/portals/${portalId}/products`, {
@@ -110,14 +138,22 @@ export class ApiHubAPI {
             headers: this.headers,
             body: JSON.stringify(body),
         });
-        return response.json();
+        const result = await this.handleResponse(response);
+        if (!("id" in result)) {
+            throw new Error("Unexpected empty response creating product");
+        }
+        return result;
     }
     async getPortalProduct(productId) {
         const response = await fetch(`${this.config.portalBasePath}/products/${productId}`, {
             method: "GET",
             headers: this.headers,
         });
-        return response.json();
+        const result = await this.handleResponse(response);
+        if (!("id" in result)) {
+            throw new ToolError("Product not found or empty response");
+        }
+        return result;
     }
     async deletePortalProduct(productId) {
         const response = await fetch(`${this.config.portalBasePath}/products/${productId}`, {
@@ -132,13 +168,9 @@ export class ApiHubAPI {
             headers: this.headers,
             body: JSON.stringify(body),
         });
-        // Custom error handling for updatePortalProduct
-        if (!response.ok) {
-            const errorText = await response.text().catch(() => "");
-            throw new Error(`API Hub updatePortalProduct failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`);
-        }
-        // Use handleResponse but with custom default return value
-        return this.handleResponseWithoutErrorCheck(response, { success: true });
+        return this.handleResponse(response, {
+            success: true,
+        });
     }
     /**
      * Helper method for handling responses when error checking is already done.
@@ -149,9 +181,6 @@ export class ApiHubAPI {
      * @param defaultReturn - Default value to return for empty responses
      * @returns Parsed response data or fallback value
      */
-    async handleResponseWithoutErrorCheck(response, defaultReturn = {}) {
-        return this.parseResponse(response, defaultReturn);
-    }
     // Registry API methods for SwaggerHub Design functionality
     /**
      * Search APIs and Domains in SwaggerHub Registry using /specs endpoint
@@ -184,7 +213,7 @@ export class ApiHubAPI {
             headers: this.headers,
         });
         if (!response.ok) {
-            throw new Error(`SwaggerHub Registry API searchApis failed - status: ${response.status} ${response.statusText}`);
+            throw new ToolError(`SwaggerHub Registry API searchApis failed - status: ${response.status} ${response.statusText}`);
         }
         const apisJsonResponse = (await response.json());
         // Transform APIs.json response to our ApiMetadata format
@@ -239,7 +268,7 @@ export class ApiHubAPI {
             headers: this.headers,
         });
         if (!response.ok) {
-            throw new Error(`SwaggerHub Registry API getApiDefinition failed - status: ${response.status} ${response.statusText}`);
+            throw new ToolError(`SwaggerHub Registry API getApiDefinition failed - status: ${response.status} ${response.statusText}`);
         }
         // Return the raw API definition (could be JSON or YAML)
         const contentType = response.headers.get("content-type");
@@ -250,4 +279,150 @@ export class ApiHubAPI {
             return response.text();
         }
     }
+    /**
+     * Create or Update API in SwaggerHub Registry
+     * @param params Parameters for creating or updating the API including owner, name, version, specification, and definition
+     * @returns Created or updated API metadata with URL. HTTP 201 indicates creation, HTTP 200 indicates update
+     */
+    async createOrUpdateApi(params) {
+        // Determine the format of the definition
+        let contentType;
+        let requestBody;
+        // Auto-detect format from the definition content
+        const format = this.detectDefinitionFormat(params.definition);
+        if (format === "yaml") {
+            contentType = "application/yaml";
+            requestBody = params.definition; // Send YAML as-is
+        }
+        else {
+            contentType = "application/json";
+            // For JSON, parse and stringify to ensure valid JSON
+            try {
+                const parsedDefinition = JSON.parse(params.definition);
+                requestBody = JSON.stringify(parsedDefinition);
+            }
+            catch (error) {
+                throw new ToolError(`Invalid JSON format in definition: ${error instanceof Error ? error.message : "Unknown error"}`);
+            }
+        }
+        // Construct the URL with query parameters
+        // Fixed values: visibility=private, automock=false, version=1.0.0
+        const searchParams = new URLSearchParams();
+        searchParams.append("isPrivate", "true");
+        const url = `${this.config.registryBasePath}/apis/${encodeURIComponent(params.owner)}/${encodeURIComponent(params.apiName)}?${searchParams.toString()}`;
+        // Use POST method with the appropriate content type
+        const response = await fetch(url, {
+            method: "POST",
+            headers: {
+                ...this.headers,
+                "Content-Type": contentType,
+            },
+            body: requestBody,
+        });
+        if (!response.ok) {
+            const errorText = await response.text().catch(() => "");
+            throw new ToolError(`SwaggerHub Registry API createOrUpdateApi failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}. URL: ${url}`);
+        }
+        // Determine operation type based on HTTP status code
+        const operation = response.status === 201 ? "create" : "update";
+        // Return formatted response with the required fields
+        // Fixed version is always 1.0.0
+        return {
+            owner: params.owner,
+            apiName: params.apiName,
+            version: "1.0.0",
+            url: `https://app.swaggerhub.com/apis/${params.owner}/${params.apiName}/1.0.0`,
+            operation,
+        };
+    }
+    /**
+     * Create API from Template in SwaggerHub Registry
+     * @param params Parameters for creating API from template including owner, api name, and template
+     * @returns Created API metadata with URL. HTTP 201 indicates creation, HTTP 200 indicates update
+     */
+    async createApiFromTemplate(params) {
+        // Construct the URL with query parameters
+        // Fixed values: visibility=private, no project, noReconcile=false
+        const searchParams = new URLSearchParams();
+        searchParams.append("isPrivate", "true");
+        searchParams.append("template", params.template);
+        const url = `${this.config.registryBasePath}/apis/${encodeURIComponent(params.owner)}/${encodeURIComponent(params.apiName)}/.template?${searchParams.toString()}`;
+        // Use POST method for template creation
+        const response = await fetch(url, {
+            method: "POST",
+            headers: this.headers,
+        });
+        if (!response.ok) {
+            const errorText = await response.text().catch(() => "");
+            throw new ToolError(`SwaggerHub Registry API createApiFromTemplate failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}. URL: ${url}`);
+        }
+        // Determine operation type based on HTTP status code
+        const operation = response.status === 201 ? "create" : "update";
+        // Return formatted response with the required fields
+        return {
+            owner: params.owner,
+            apiName: params.apiName,
+            template: params.template,
+            url: `https://app.swaggerhub.com/apis/${params.owner}/${params.apiName}`,
+            operation,
+        };
+    }
+    /**
+     * Auto-detect the format of an API definition string
+     * @param definition The API definition content
+     * @returns 'json' or 'yaml'
+     */
+    detectDefinitionFormat(definition) {
+        const trimmed = definition.trim();
+        if (!trimmed) {
+            throw new ToolError("Empty definition content provided");
+        }
+        try {
+            JSON.parse(trimmed);
+            return "json";
+        }
+        catch {
+            return "yaml";
+        }
+    }
+    /**
+     * Run a standardization scan against an API definition
+     * @param params Parameters including organization name and API definition
+     * @returns Standardization result with validation errors
+     */
+    async scanStandardization(params) {
+        // Auto-detect format from the definition content
+        const format = this.detectDefinitionFormat(params.definition);
+        let contentType;
+        let requestBody;
+        if (format === "yaml") {
+            contentType = "application/yaml";
+            requestBody = params.definition; // Send YAML as-is
+        }
+        else {
+            contentType = "application/json";
+            // For JSON, parse and stringify to ensure valid JSON
+            try {
+                const parsedDefinition = JSON.parse(params.definition);
+                requestBody = JSON.stringify(parsedDefinition);
+            }
+            catch (error) {
+                throw new Error(`Invalid JSON format in definition: ${error instanceof Error ? error.message : "Unknown error"}`);
+            }
+        }
+        const url = `${this.config.registryBasePath}/standardization/${encodeURIComponent(params.orgName)}/scan`;
+        const response = await fetch(url, {
+            method: "POST",
+            headers: {
+                ...this.headers,
+                "Content-Type": contentType,
+            },
+            body: requestBody,
+        });
+        if (!response.ok) {
+            const errorText = await response.text().catch(() => "");
+            throw new Error(`SwaggerHub Registry API scanStandardization failed - status: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}. URL: ${url}`);
+        }
+        return await this.handleResponse(response);
+    }
 }

package/dist/api-hub/client/registry-types.js

@@ -53,3 +53,25 @@ export const ApiDefinitionParamsSchema = z.object({
         .optional()
         .describe("Set to true to create models from inline schemas in OpenAPI definition (default false)"),
 });
+export const CreateApiParamsSchema = z.object({
+    owner: z.string().describe("Organization name (owner of the API)"),
+    apiName: z.string().describe("API name"),
+    definition: z
+        .string()
+        .describe("API definition content (OpenAPI/AsyncAPI specification in JSON or YAML format). Format is automatically detected. API is created with fixed values: version 1.0.0, private visibility, automock disabled, and no project assignment."),
+});
+export const CreateApiFromTemplateParamsSchema = z.object({
+    owner: z.string().describe("Organization name (owner of the API)"),
+    apiName: z.string().describe("API name"),
+    template: z
+        .string()
+        .describe("Template name to use for creating the API. Format: owner/template-name/version (e.g., 'swagger-hub/petstore-template/1.0.0'). API is created with fixed values: private visibility, no project assignment, and reconciliation enabled."),
+});
+export const ScanStandardizationParamsSchema = z.object({
+    orgName: z
+        .string()
+        .describe("The organization name to use for standardization rules"),
+    definition: z
+        .string()
+        .describe("API definition content (OpenAPI/AsyncAPI specification in JSON or YAML format) to scan for standardization errors"),
+});

package/dist/api-hub/client/tools.js

@@ -6,7 +6,7 @@
  * This follows the pattern established in the pactflow module.
  */
 import { CreatePortalArgsSchema, CreateProductArgsSchema, PortalArgsSchema, ProductArgsSchema, UpdatePortalArgsSchema, UpdateProductArgsSchema, } from "./portal-types.js";
-import { ApiDefinitionParamsSchema, ApiSearchParamsSchema, } from "./registry-types.js";
+import { ApiDefinitionParamsSchema, ApiSearchParamsSchema, CreateApiFromTemplateParamsSchema, CreateApiParamsSchema, ScanStandardizationParamsSchema, } from "./registry-types.js";
 export const TOOLS = [
     {
         title: "List Portals",
@@ -83,4 +83,22 @@ export const TOOLS = [
         zodSchema: ApiDefinitionParamsSchema,
         handler: "getApiDefinition",
     },
+    {
+        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.",
+        zodSchema: CreateApiParamsSchema,
+        handler: "createOrUpdateApi",
+    },
+    {
+        title: "Create API from Template",
+        summary: "Create a new API in SwaggerHub Registry using a predefined template. This endpoint creates APIs based on existing templates without requiring manual definition content. APIs are always created with fixed values: private visibility, no project assignment, and reconciliation enabled (these values cannot be changed). Returns HTTP 201 for creation, HTTP 200 for update. Response includes 'operation' field and API details with SwaggerHub URL.",
+        zodSchema: CreateApiFromTemplateParamsSchema,
+        handler: "createApiFromTemplate",
+    },
+    {
+        title: "Scan API Standardization",
+        summary: "Run a standardization scan against an API definition using the organization's standardization configuration. Accepts a YAML or JSON OpenAPI/AsyncAPI definition and returns a list of standardization errors and validation issues.",
+        zodSchema: ScanStandardizationParamsSchema,
+        handler: "scanStandardization",
+    },
 ];

package/dist/api-hub/client.js

@@ -51,6 +51,15 @@ export class ApiHubClient {
     async getApiDefinition(args) {
         return this.api.getApiDefinition(args);
     }
+    async createOrUpdateApi(args) {
+        return this.api.createOrUpdateApi(args);
+    }
+    async createApiFromTemplate(args) {
+        return this.api.createApiFromTemplate(args);
+    }
+    async scanStandardization(args) {
+        return this.api.scanStandardization(args);
+    }
     registerTools(register, _getInput) {
         TOOLS.forEach((tool) => {
             const { handler, formatResponse, ...toolParams } = tool;

package/dist/bugsnag/client/api/CurrentUser.js

@@ -1,41 +1,19 @@
-import { BaseAPI, pickFieldsFromArray } from "./base.js";
-// --- API Class ---
+import { CurrentUserApiFetchParamCreator, } from "./api.js";
+import { BaseAPI } from "./base.js";
+import { ProjectAPI } from "./Project.js";
 export class CurrentUserAPI extends BaseAPI {
-    static filterFields = [
-        "collaborators_url",
-        "projects_url",
-        "upgrade_url",
+    static organizationFields = [
+        "id",
+        "name",
+        "slug",
     ];
-    static organizationFields = ["id", "name", "slug"];
-    static projectFields = ["id", "name", "slug", "api_key"];
-    constructor(configuration) {
-        super(configuration, CurrentUserAPI.filterFields);
-    }
     /**
      * List the current user's organizations
      * GET /user/organizations
      */
-    async listUserOrganizations(options = {}) {
-        const { admin, paginate = false, ...queryOptions } = options;
-        const params = new URLSearchParams();
-        if (admin !== undefined)
-            params.append("admin", String(admin));
-        for (const [key, value] of Object.entries(queryOptions)) {
-            if (value !== undefined)
-                params.append(key, String(value));
-        }
-        const url = params.toString()
-            ? `/user/organizations?${params}`
-            : "/user/organizations";
-        const data = await this.request({
-            method: "GET",
-            url,
-        }, paginate);
-        // Only return allowed fields
-        return {
-            ...data,
-            body: pickFieldsFromArray(data.body || [], CurrentUserAPI.organizationFields),
-        };
+    async listUserOrganizations(admin, perPage, options = {}) {
+        const localVarFetchArgs = CurrentUserApiFetchParamCreator(this.configuration).listUserOrganizations(admin, perPage, options);
+        return await this.requestArray(localVarFetchArgs.url, localVarFetchArgs.options, true, CurrentUserAPI.organizationFields);
     }
     /**
      * List projects for a given organization
@@ -44,23 +22,8 @@ export class CurrentUserAPI extends BaseAPI {
      * @param options Optional parameters for filtering, pagination, etc.
      * @returns A promise that resolves to the list of projects in the organization
      */
-    async getOrganizationProjects(organizationId, options = {}) {
-        const { ...queryOptions } = options;
-        const params = new URLSearchParams();
-        for (const [key, value] of Object.entries(queryOptions)) {
-            if (value !== undefined)
-                params.append(key, String(value));
-        }
-        const url = params.toString()
-            ? `/organizations/${organizationId}/projects?${params}`
-            : `/organizations/${organizationId}/projects`;
-        const data = await this.request({
-            method: "GET",
-            url,
-        }, true); // Always paginate for projects
-        return {
-            ...data,
-            body: pickFieldsFromArray(data.body || [], CurrentUserAPI.projectFields),
-        };
+    async getOrganizationProjects(organizationId, q, sort, direction, perPage, options) {
+        const localVarFetchArgs = CurrentUserApiFetchParamCreator(this.configuration).getOrganizationProjects(organizationId, q, sort, direction, perPage, options);
+        return await this.requestArray(localVarFetchArgs.url, localVarFetchArgs.options, true, ProjectAPI.projectFields);
     }
 }