@smartbear/mcp 0.7.0 → 0.8.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

@@ -39,13 +39,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.
@@ -66,7 +79,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 +88,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 Error("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 Error(`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 +128,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 +137,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 Error("Product not found or empty response");
+        }
+        return result;
     }
     async deletePortalProduct(productId) {
         const response = await fetch(`${this.config.portalBasePath}/products/${productId}`, {
@@ -132,13 +167,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 +180,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
@@ -250,4 +278,110 @@ 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 Error(`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 Error(`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 Error(`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 Error("Empty definition content provided");
+        }
+        try {
+            JSON.parse(trimmed);
+            return "json";
+        }
+        catch {
+            return "yaml";
+        }
+    }
 }

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

@@ -53,3 +53,17 @@ 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."),
+});

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, } from "./registry-types.js";
 export const TOOLS = [
     {
         title: "List Portals",
@@ -83,4 +83,16 @@ 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",
+    },
 ];

package/dist/api-hub/client.js

@@ -51,6 +51,12 @@ 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);
+    }
     registerTools(register, _getInput) {
         TOOLS.forEach((tool) => {
             const { handler, formatResponse, ...toolParams } = tool;

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

@@ -1,4 +1,5 @@
 import { BaseAPI, pickFieldsFromArray } from "./base.js";
+import { ProjectAPI } from "./Project.js";
 // --- API Class ---
 export class CurrentUserAPI extends BaseAPI {
     static filterFields = [
@@ -7,7 +8,6 @@ export class CurrentUserAPI extends BaseAPI {
         "upgrade_url",
     ];
     static organizationFields = ["id", "name", "slug"];
-    static projectFields = ["id", "name", "slug", "api_key"];
     constructor(configuration) {
         super(configuration, CurrentUserAPI.filterFields);
     }
@@ -16,7 +16,7 @@ export class CurrentUserAPI extends BaseAPI {
      * GET /user/organizations
      */
     async listUserOrganizations(options = {}) {
-        const { admin, paginate = false, ...queryOptions } = options;
+        const { admin, ...queryOptions } = options;
         const params = new URLSearchParams();
         if (admin !== undefined)
             params.append("admin", String(admin));
@@ -30,7 +30,7 @@ export class CurrentUserAPI extends BaseAPI {
         const data = await this.request({
             method: "GET",
             url,
-        }, paginate);
+        });
         // Only return allowed fields
         return {
             ...data,
@@ -57,10 +57,10 @@ export class CurrentUserAPI extends BaseAPI {
         const data = await this.request({
             method: "GET",
             url,
-        }, true); // Always paginate for projects
+        });
         return {
             ...data,
-            body: pickFieldsFromArray(data.body || [], CurrentUserAPI.projectFields),
+            body: pickFieldsFromArray(data.body || [], ProjectAPI.projectFields),
         };
     }
 }

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

@@ -45,33 +45,21 @@ export class ErrorAPI extends BaseAPI {
         }));
     }
     /**
-     * View the latest Event on an Error
-     * GET /errors/{error_id}/latest_event
-     */
-    async viewLatestEventOnError(errorId, options = {}) {
-        const params = new URLSearchParams();
-        for (const [key, value] of Object.entries(options)) {
-            if (value !== undefined)
-                params.append(key, String(value));
-        }
-        const url = params.toString()
-            ? `/errors/${errorId}/latest_event?${params}`
-            : `/errors/${errorId}/latest_event`;
-        return (await this.request({
-            method: "GET",
-            url,
-        }));
-    }
-    /**
-     * List the Events on a Project
+     * Get the latest Event in a Project, with optional filters
      * GET /projects/{project_id}/events
      */
-    async listEventsOnProject(projectId, queryString = "") {
+    async getLatestEventOnProject(projectId, queryString = "") {
         const url = `/projects/${projectId}/events${queryString}`;
-        return await this.request({
+        const response = await this.request({
             method: "GET",
             url,
         });
+        return {
+            ...response,
+            body: response.body && response.body.length > 0
+                ? response.body[0]
+                : undefined, // Return only the latest event
+        };
     }
     /**
      * View an Event by ID
@@ -98,8 +86,8 @@ export class ErrorAPI extends BaseAPI {
     async listProjectErrors(projectId, options = {}) {
         let url = `/projects/${projectId}/errors`;
         // Next links need to be used as-is to ensure results are consistent, so only the page size can be modified
-        if (options.next !== undefined) {
-            const nextUrl = new URL(options.next);
+        if (options.next_url !== undefined) {
+            const nextUrl = new URL(options.next_url);
             if (options.per_page !== undefined) {
                 nextUrl.searchParams.set("per_page", options.per_page.toString());
             }
@@ -134,7 +122,7 @@ export class ErrorAPI extends BaseAPI {
         return (await this.request({
             method: "GET",
             url,
-        }));
+        }, false));
     }
     /**
      * Update an Error on a Project

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

@@ -1,6 +1,15 @@
-import { BaseAPI, pickFields, pickFieldsFromArray, } from "./base.js";
+import { BaseAPI, pickFieldsFromArray } from "./base.js";
 // --- API Class ---
 export class ProjectAPI extends BaseAPI {
+    static projectFields = [
+        "id",
+        "name",
+        "slug",
+        "api_key",
+        "stability_target_type",
+        "target_stability",
+        "critical_stability",
+    ];
     static filterFields = [
         "errors_url",
         "events_url",
@@ -39,11 +48,6 @@ export class ProjectAPI extends BaseAPI {
         "accumulative_daily_users_seen",
         "accumulative_daily_users_with_unhandled",
     ];
-    static stabilityFields = [
-        "critical_stability",
-        "target_stability",
-        "stability_target_type",
-    ];
     constructor(configuration) {
         super(configuration, ProjectAPI.filterFields);
     }
@@ -80,20 +84,6 @@ export class ProjectAPI extends BaseAPI {
             body: data,
         });
     }
-    /**
-     * Retrieves the stability targets for a specific project.
-     * GET /projects/{project_id} (with internal header)
-     * @param projectId The ID of the project.
-     * @returns A promise that resolves to the project's stability targets.
-     */
-    async getProjectStabilityTargets(projectId) {
-        const url = `/projects/${projectId}`;
-        const response = await this.request({
-            method: "GET",
-            url,
-        });
-        return pickFields(response.body || {}, ProjectAPI.stabilityFields);
-    }
     /**
      * Lists builds for a specific project.
      * GET /projects/{project_id}/releases
@@ -107,7 +97,7 @@ export class ProjectAPI extends BaseAPI {
         const response = await this.request({
             method: "GET",
             url,
-        });
+        }, false);
         return {
             ...response,
             body: pickFieldsFromArray(response.body || [], ProjectAPI.buildFields),
@@ -136,11 +126,14 @@ export class ProjectAPI extends BaseAPI {
      */
     async listReleases(projectId, opts) {
         const url = opts.next_url ??
-            `/projects/${projectId}/release_groups?release_stage_name=${opts.release_stage_name}&visible_only=${opts.visible_only}&top_only=true`;
+            `/projects/${projectId}/release_groups?` +
+                `release_stage_name=${opts.release_stage_name ?? "production"}&` +
+                `visible_only=${opts.visible_only ?? false}&` +
+                `top_only=${opts.top_only ?? false}`;
         const response = await this.request({
             method: "GET",
             url,
-        });
+        }, false);
         return {
             ...response,
             body: pickFieldsFromArray(response.body || [], ProjectAPI.releaseFields),

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

@@ -24,6 +24,16 @@ export function getNextUrlPathFromHeader(headers, basePath) {
         return null;
     return match.replace(basePath, "");
 }
+// Utility to extract total count from headers
+export function getTotalCountFromHeader(headers) {
+    if (!headers)
+        return null;
+    const totalCount = headers.get("X-Total-Count");
+    if (!totalCount)
+        return null;
+    const parsed = parseInt(totalCount, 10);
+    return Number.isNaN(parsed) ? null : parsed;
+}
 // Ensure URL is absolute
 // The MCP tools exposed use only the path for pagination
 // For making requests, we need to ensure the URL is absolute
@@ -37,7 +47,7 @@ export class BaseAPI {
         this.configuration = configuration;
         this.filterFields = filterFields || [];
     }
-    async request(options, paginate = false) {
+    async request(options, fetchAll = true) {
         const headers = {
             ...this.configuration.headers,
             ...options.headers,
@@ -66,16 +76,18 @@ export class BaseAPI {
                 headers: response.headers,
             };
             const data = await response.json();
-            if (paginate) {
+            nextUrl = getNextUrlPathFromHeader(response.headers, this.configuration.basePath);
+            if (Array.isArray(data)) {
                 results = results.concat(data);
-                nextUrl = getNextUrlPathFromHeader(response.headers, this.configuration.basePath);
+                apiResponse.nextUrl = nextUrl;
             }
             else {
                 apiResponse.body = data;
             }
-        } while (paginate && nextUrl);
-        if (paginate) {
+        } while (fetchAll && nextUrl);
+        if (results.length > 0) {
             apiResponse.body = results;
+            apiResponse.totalCount = getTotalCountFromHeader(apiResponse.headers);
         }
         if (Array.isArray(apiResponse.body)) {
             apiResponse.body.forEach(this.sanitizeResponse.bind(this));