@smartbear/mcp 0.9.0 → 0.11.0

package/dist/zephyr/tool/priority/get-priorities.js

@@ -0,0 +1,43 @@
+import { listPrioritiesQueryParams, listPrioritiesResponse, } from "../../common/rest-api-schemas.js";
+export class GetPriorities {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get priorities",
+        summary: "Get Zephyr Test Case priorities with optional filters",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listPrioritiesQueryParams,
+        outputSchema: listPrioritiesResponse,
+        examples: [
+            {
+                description: "Get the first 10 priorities",
+                parameters: {
+                    maxResults: 10,
+                    startAt: 0,
+                },
+                expectedOutput: "The first 10 priorities with their details",
+            },
+            {
+                description: "Get priorities for a specific project",
+                parameters: { projectKey: "PROJ" },
+                expectedOutput: "The priorities for project PROJ",
+            },
+            {
+                description: "Get all priorities",
+                parameters: {},
+                expectedOutput: "All priorities",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const getPrioritiesInput = listPrioritiesQueryParams.parse(args);
+        const response = await this.apiClient.get("/priorities", getPrioritiesInput);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/project/get-project.js

@@ -0,0 +1,39 @@
+import { getProjectParams, getProjectResponse, } from "../../common/rest-api-schemas.js";
+export class GetProject {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Project",
+        summary: "Get details of project specified by id or key in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: getProjectParams,
+        outputSchema: getProjectResponse,
+        examples: [
+            {
+                description: "Get the project with id 1",
+                parameters: {
+                    projectIdOrKey: "1",
+                },
+                expectedOutput: "The project with its details",
+            },
+            {
+                description: "Get the project with key 'PROJ'",
+                parameters: {
+                    projectIdOrKey: "PROJ",
+                },
+                expectedOutput: "The project with its details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const { projectIdOrKey } = getProjectParams.parse(args);
+        const response = await this.apiClient.get(`/projects/${projectIdOrKey}`);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/project/get-projects.js

@@ -1,9 +1,4 @@
-import { z } from "zod";
-import { MaxResultsSchema, StartAtSchema } from "../../common/types.js";
-export const GetProjectsInputSchema = z.object({
-    startAt: StartAtSchema.optional(),
-    maxResults: MaxResultsSchema.optional(),
-});
+import { listProjectsQueryParams, listProjectsResponse, } from "../../common/rest-api-schemas.js";
 export class GetProjects {
     apiClient;
     constructor(apiClient) {
@@ -14,7 +9,8 @@ export class GetProjects {
         summary: "Get details of projects in Zephyr",
         readOnly: true,
         idempotent: true,
-        zodSchema: GetProjectsInputSchema,
+        inputSchema: listProjectsQueryParams,
+        outputSchema: listProjectsResponse,
         examples: [
             {
                 description: "Get the first 10 projects",
@@ -42,13 +38,11 @@ export class GetProjects {
         ],
     };
     handle = async (args) => {
-        const { maxResults, startAt } = args;
-        const response = await this.apiClient.get("/projects", {
-            maxResults,
-            startAt,
-        });
+        const parsedArgs = listProjectsQueryParams.parse(args);
+        const response = await this.apiClient.get("/projects", parsedArgs);
         return {
-            content: [{ type: "text", text: JSON.stringify(response) }],
+            structuredContent: response,
+            content: [],
         };
     };
 }

package/dist/zephyr/tool/status/get-statuses.js

@@ -0,0 +1,49 @@
+import { listStatusesQueryParams, listStatusesResponse, } from "../../common/rest-api-schemas.js";
+export class GetStatuses {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Statuses",
+        summary: "Get statuses of different types of test artifacts in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listStatusesQueryParams,
+        outputSchema: listStatusesResponse,
+        examples: [
+            {
+                description: "Get the first 10 statuses",
+                parameters: {
+                    maxResults: 10,
+                    startAt: 0,
+                },
+                expectedOutput: "The first 10 statuses with their details from different projects and test artifact types",
+            },
+            {
+                description: "Get 10 test case statuses",
+                parameters: {
+                    maxResults: 10,
+                    statusType: "TEST_CASE",
+                },
+                expectedOutput: "A list of statuses related to test cases with their details",
+            },
+            {
+                description: "Get five statuses from the project PROJ",
+                parameters: {
+                    maxResults: 5,
+                    projectKey: "PROJ",
+                },
+                expectedOutput: "The first five statuses from the project PROJ with their details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const getStatusesInput = listStatusesQueryParams.parse(args);
+        const response = await this.apiClient.get("/statuses", getStatusesInput);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/test-case/get-test-case.js

@@ -0,0 +1,39 @@
+import { getTestCaseParams, getTestCaseResponse, } from "../../common/rest-api-schemas.js";
+export class GetTestCase {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Test Case",
+        summary: "Get details of test case specified by key in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: getTestCaseParams,
+        outputSchema: getTestCaseResponse,
+        examples: [
+            {
+                description: "Get the test case with key 'SA-T10'",
+                parameters: {
+                    testCaseKey: "SA-T10",
+                },
+                expectedOutput: "The test case with its details",
+            },
+            {
+                description: "Get the test case with key 'MM2-T1'",
+                parameters: {
+                    testCaseKey: "MM2-T1",
+                },
+                expectedOutput: "The test case with its details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const { testCaseKey } = getTestCaseParams.parse(args);
+        const response = await this.apiClient.get(`/testcases/${testCaseKey}`);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/test-case/get-test-cases.js

@@ -0,0 +1,64 @@
+import { listTestCasesCursorPaginatedQueryParams, listTestCasesCursorPaginatedResponse, } from "../../common/rest-api-schemas.js";
+export class GetTestCases {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Test Cases",
+        summary: "Get details of test cases in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listTestCasesCursorPaginatedQueryParams,
+        outputSchema: listTestCasesCursorPaginatedResponse,
+        examples: [
+            {
+                description: "Get the first 10 Test Cases",
+                parameters: {
+                    limit: 10,
+                    startAtId: 1,
+                },
+                expectedOutput: "The first 10 Test Cases with their details",
+            },
+            {
+                description: "Get any Test Case",
+                parameters: {
+                    limit: 1,
+                },
+                expectedOutput: "One Test Case with its details",
+            },
+            {
+                description: "Get five Test Cases starting from the ID 123",
+                parameters: {
+                    limit: 5,
+                    startAtId: 123,
+                },
+                expectedOutput: "Five Test Cases starting from the ID 123 with their details",
+            },
+            {
+                description: "Get one Test Case from the project PROJ",
+                parameters: {
+                    projectKey: "PROJ",
+                    limit: 1,
+                },
+                expectedOutput: "One Test Case from project PROJ with its details",
+            },
+            {
+                description: "Get one Test Case from the folder with ID 123",
+                parameters: {
+                    folderId: 123,
+                    limit: 1,
+                },
+                expectedOutput: "One Test Case from folder with ID 123 with its details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const parsedArgs = listTestCasesCursorPaginatedQueryParams.parse(args);
+        const response = await this.apiClient.get("/testcases/nextgen", parsedArgs);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/test-cycle/get-test-cycle.js

@@ -0,0 +1,39 @@
+import { getTestCycleParams, getTestCycleResponse, } from "../../common/rest-api-schemas.js";
+export class GetTestCycle {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Test Cycle",
+        summary: "Get details of test cycle specified by id or key in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: getTestCycleParams,
+        outputSchema: getTestCycleResponse,
+        examples: [
+            {
+                description: "Get the test cycle with id 1",
+                parameters: {
+                    testCycleIdOrKey: "1",
+                },
+                expectedOutput: "The test cycle with its details",
+            },
+            {
+                description: "Get the test cycle with key 'SA-R40'",
+                parameters: {
+                    testCycleIdOrKey: "SA-R40",
+                },
+                expectedOutput: "The test cycle with its details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const { testCycleIdOrKey } = getTestCycleParams.parse(args);
+        const response = await this.apiClient.get(`/testcycles/${testCycleIdOrKey}`);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/test-cycle/get-test-cycles.js

@@ -0,0 +1,72 @@
+import { listTestCyclesQueryParams, listTestCyclesResponse, } from "../../common/rest-api-schemas.js";
+export class GetTestCycles {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Test Cycles",
+        summary: "Get details of Test Cycles in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listTestCyclesQueryParams,
+        outputSchema: listTestCyclesResponse,
+        examples: [
+            {
+                description: "Get the first 10 Test Cycles",
+                parameters: {
+                    maxResults: 10,
+                    startAt: 0,
+                },
+                expectedOutput: "The first 10 Test Cycles with their details",
+            },
+            {
+                description: "Get any Test Cycle",
+                parameters: {
+                    maxResults: 1,
+                },
+                expectedOutput: "One Test Cycle with its details",
+            },
+            {
+                description: "Get five Test Cycles starting from the 7th Test Cycles of the list",
+                parameters: {
+                    maxResults: 5,
+                    startAt: 6,
+                },
+                expectedOutput: "The 7th to the 11th Test Cycles with their details",
+            },
+            {
+                description: "Get one Test Cycle from the project PROJ",
+                parameters: {
+                    projectKey: "PROJ",
+                    maxResults: 1,
+                },
+                expectedOutput: "One Test Cycle from project PROJ with its details",
+            },
+            {
+                description: "Get one Test Cycle from the folder with ID 123",
+                parameters: {
+                    folderId: 123,
+                    maxResults: 1,
+                },
+                expectedOutput: "One Test Cycle from folder with ID 123 with its details",
+            },
+            {
+                description: "Get one Test Cycle from the version 456",
+                parameters: {
+                    jiraProjectVersionId: 456,
+                    maxResults: 1,
+                },
+                expectedOutput: "One Test Cycle from version 456 with its details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const parsedArgs = listTestCyclesQueryParams.parse(args);
+        const response = await this.apiClient.get("/testcycles", parsedArgs);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/test-execution/get-test-execution.js

@@ -0,0 +1,39 @@
+import { getTestExecutionParams, getTestExecutionResponse, } from "../../common/rest-api-schemas.js";
+export class GetTestExecution {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Test Execution",
+        summary: "Get details of test execution specified by id or key in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: getTestExecutionParams,
+        outputSchema: getTestExecutionResponse,
+        examples: [
+            {
+                description: "Get the test execution with id 1",
+                parameters: {
+                    testExecutionIdOrKey: "1",
+                },
+                expectedOutput: "The test execution with its details",
+            },
+            {
+                description: "Get the test execution with key 'PROJ-E123'",
+                parameters: {
+                    testExecutionIdOrKey: "PROJ-E123",
+                },
+                expectedOutput: "The test execution with its details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const { testExecutionIdOrKey } = getTestExecutionParams.parse(args);
+        const response = await this.apiClient.get(`/testexecutions/${testExecutionIdOrKey}`);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@smartbear/mcp",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "MCP server for interacting SmartBear Products",
   "keywords": [
     "smartbear",
     "mcp",
     "bugsnag",
     "reflect",
-    "api-hub",
+    "swagger",
     "pactflow",
     "zephyr"
   ],

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

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

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

@@ -1,104 +0,0 @@
-/**
- * TOOLS
- *
- * Defines tool configurations for API Hub operations.
- * Each tool includes parameters, descriptions, and handler method names.
- * This follows the pattern established in the pactflow module.
- */
-import { CreatePortalArgsSchema, CreateProductArgsSchema, PortalArgsSchema, ProductArgsSchema, UpdatePortalArgsSchema, UpdateProductArgsSchema, } from "./portal-types.js";
-import { ApiDefinitionParamsSchema, ApiSearchParamsSchema, CreateApiFromTemplateParamsSchema, CreateApiParamsSchema, ScanStandardizationParamsSchema, } from "./registry-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.",
-        parameters: [],
-        handler: "getPortals",
-    },
-    {
-        title: "Create Portal",
-        summary: "Create a new portal within API Hub.",
-        zodSchema: CreatePortalArgsSchema,
-        handler: "createPortal",
-    },
-    {
-        title: "Get Portal",
-        summary: "Retrieve information about a specific portal.",
-        zodSchema: PortalArgsSchema,
-        handler: "getPortal",
-    },
-    {
-        title: "Delete Portal",
-        summary: "Delete a specific portal.",
-        zodSchema: PortalArgsSchema,
-        handler: "deletePortal",
-        formatResponse: () => "Portal deleted successfully.",
-    },
-    {
-        title: "Update Portal",
-        summary: "Update a specific portal's configuration.",
-        zodSchema: UpdatePortalArgsSchema,
-        handler: "updatePortal",
-    },
-    {
-        title: "List Portal Products",
-        summary: "Get products for a specific portal that match your criteria.",
-        zodSchema: PortalArgsSchema,
-        handler: "getPortalProducts",
-    },
-    {
-        title: "Create Portal Product",
-        summary: "Create a new product for a specific portal.",
-        zodSchema: CreateProductArgsSchema,
-        handler: "createPortalProduct",
-    },
-    {
-        title: "Get Portal Product",
-        summary: "Retrieve information about a specific product resource.",
-        zodSchema: ProductArgsSchema,
-        handler: "getPortalProduct",
-    },
-    {
-        title: "Delete Portal Product",
-        summary: "Delete a product from a specific portal",
-        zodSchema: ProductArgsSchema,
-        handler: "deletePortalProduct",
-        formatResponse: () => "Product deleted successfully.",
-    },
-    {
-        title: "Update Portal Product",
-        summary: "Update a product's settings within a specific portal.",
-        zodSchema: UpdateProductArgsSchema,
-        handler: "updatePortalProduct",
-    },
-    // Registry API tools for SwaggerHub Design functionality
-    {
-        title: "Search APIs and Domains",
-        summary: "Search for APIs and Domains in SwaggerHub Registry using the comprehensive /specs endpoint and retrieve metadata including owner, name, description, summary, version, and specification.",
-        zodSchema: ApiSearchParamsSchema,
-        handler: "searchApis",
-    },
-    {
-        title: "Get API Definition",
-        summary: "Fetch resolved API definition from SwaggerHub Registry based on owner, API name, and version.",
-        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

@@ -1,98 +0,0 @@
-import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
-import { ApiHubAPI, ApiHubConfiguration, TOOLS, } from "./client/index.js";
-// Tool definitions for API Hub API client
-export class ApiHubClient {
-    config;
-    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
-    async getPortals() {
-        return this.api.getPortals();
-    }
-    async createPortal(body) {
-        return this.api.createPortal(body);
-    }
-    async getPortal(args) {
-        return this.api.getPortal(args.portalId);
-    }
-    async deletePortal(args) {
-        return this.api.deletePortal(args.portalId);
-    }
-    async updatePortal(args) {
-        const { portalId, ...body } = args;
-        return this.api.updatePortal(portalId, body);
-    }
-    async getPortalProducts(args) {
-        return this.api.getPortalProducts(args.portalId);
-    }
-    async createPortalProduct(args) {
-        const { portalId, ...body } = args;
-        return this.api.createPortalProduct(portalId, body);
-    }
-    async getPortalProduct(args) {
-        return this.api.getPortalProduct(args.productId);
-    }
-    async deletePortalProduct(args) {
-        return this.api.deletePortalProduct(args.productId);
-    }
-    async updatePortalProduct(args) {
-        const { productId, ...body } = args;
-        return this.api.updatePortalProduct(productId, body);
-    }
-    // Registry API methods for SwaggerHub Design functionality
-    async searchApis(args = {}) {
-        return this.api.searchApis(args);
-    }
-    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;
-            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 ApiHubClient`);
-                    }
-                    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)}`,
-                            },
-                        ],
-                    };
-                }
-            });
-        });
-    }
-}