@smartbear/mcp 0.8.0 → 0.10.0

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/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 123",
+                parameters: {
+                    folderId: 123,
+                    maxResults: 1,
+                },
+                expectedOutput: "One Test Cycle from folder 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartbear/mcp",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "MCP server for interacting SmartBear Products",
   "keywords": [
     "smartbear",

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

@@ -1,167 +0,0 @@
-/**
- * Filters utility for BugSnag API
- *
- * This file provides utility functions for creating filter URL parameters
- * based on the BugSnag filtering specification described in the Filtering.md document.
- */
-import { z } from "zod";
-export const FilterValueSchema = z.object({
-    type: z.enum(["eq", "ne", "empty"]),
-    value: z.union([z.string(), z.boolean(), z.number()]),
-});
-export const FilterObjectSchema = z.record(z.array(FilterValueSchema));
-/**
- * Creates a filter value object for equality comparison
- *
- * @param value The value to compare against
- * @returns FilterValue with type 'eq'
- */
-export function equals(value) {
-    return {
-        type: "eq",
-        value,
-    };
-}
-/**
- * Creates a filter value object for inequality comparison
- *
- * @param value The value to compare against
- * @returns FilterValue with type 'ne'
- */
-export function notEquals(value) {
-    return {
-        type: "ne",
-        value,
-    };
-}
-/**
- * Creates a filter value object for checking if a field is empty or not
- *
- * @param isEmpty Whether the field should be empty (true) or not (false)
- * @returns FilterValue with type 'empty'
- */
-export function empty(isEmpty) {
-    return {
-        type: "empty",
-        value: isEmpty.toString(),
-    };
-}
-/**
- * Creates a relative time filter for event.since or event.before
- *
- * @param value The amount of time
- * @param unit The time unit ('h' for hours, 'd' for days)
- * @returns FilterValue for the relative time
- */
-export function relativeTime(value, unit) {
-    return {
-        type: "eq",
-        value: `${value}${unit}`,
-    };
-}
-/**
- * Creates an ISO 8601 time filter (must be in UTC format like 2018-05-20T00:00:00Z)
- *
- * @param date The date object to convert to ISO string
- * @returns FilterValue for the ISO time
- */
-export function isoTime(date) {
-    return {
-        type: "eq",
-        value: date.toISOString(),
-    };
-}
-/**
- * Converts a FilterObject to URL search parameters
- *
- * @param filters The filter object to convert
- * @returns URLSearchParams object with the encoded filters
- */
-export function toUrlSearchParams(filters) {
-    const params = new URLSearchParams();
-    Object.entries(filters).forEach(([field, filterValues]) => {
-        filterValues.forEach((filterValue) => {
-            params.append(`filters[${field}][][type]`, filterValue.type);
-            params.append(`filters[${field}][][value]`, filterValue.value.toString());
-        });
-    });
-    return params;
-}
-/**
- * Converts a FilterObject to a query string
- *
- * @param filters The filter object to convert
- * @returns Query string representation of the filters
- */
-export function toQueryString(filters) {
-    return toUrlSearchParams(filters).toString();
-}
-/**
- * Helper to build a FilterObject with type safety
- *
- * @returns An empty FilterObject that can be built upon
- */
-export function createFilter() {
-    return {};
-}
-/**
- * Adds a field filter to an existing FilterObject
- *
- * @param filters The FilterObject to add to
- * @param field The field name (e.g., 'error.status', 'event.since')
- * @param filterValue The FilterValue to add
- * @returns The updated FilterObject for chaining
- */
-export function addFilter(filters, field, filterValue) {
-    if (!filters[field]) {
-        filters[field] = [];
-    }
-    filters[field].push(filterValue);
-    return filters;
-}
-/**
- * Utility to create a time range filter between two dates
- *
- * @param filters The FilterObject to add to
- * @param since Start date
- * @param before End date
- * @returns The updated FilterObject for chaining
- */
-export function addTimeRange(filters, since, before) {
-    addFilter(filters, "event.since", isoTime(since));
-    addFilter(filters, "event.before", isoTime(before));
-    return filters;
-}
-/**
- * Utility to create a relative time range filter
- *
- * @param filters The FilterObject to add to
- * @param amount The amount of time (e.g., 7 for 7 days)
- * @param unit The time unit ('h' for hours, 'd' for days)
- * @returns The updated FilterObject for chaining
- */
-export function addRelativeTimeRange(filters, amount, unit) {
-    addFilter(filters, "event.since", relativeTime(amount, unit));
-    return filters;
-}
-/**
- * Usage examples:
- *
- * // Example 1: Open errors with events in the last day
- * const filters = createFilter();
- * addRelativeTimeRange(filters, 1, 'd');
- * addFilter(filters, 'error.status', equals('open'));
- * const queryString = toQueryString(filters);
- *
- * // Example 2: Events affecting specific users on a specific day
- * const filters = createFilter();
- * addTimeRange(filters, new Date('2017-01-01'), new Date('2017-01-02'));
- * addFilter(filters, 'user.email', equals('user1@example.com'));
- * addFilter(filters, 'user.email', equals('user2@example.com'));
- * const queryString = toQueryString(filters);
- *
- * // Example 3: Events that have user data
- * const filters = createFilter();
- * addFilter(filters, 'user.id', empty(false));
- * const queryString = toQueryString(filters);
- */

package/dist/bugsnag/client/configuration.js

@@ -1,10 +0,0 @@
-export class Configuration {
-    authToken;
-    basePath;
-    headers;
-    constructor(param) {
-        this.authToken = param.authToken;
-        this.basePath = param.basePath;
-        this.headers = param.headers || {};
-    }
-}

package/dist/bugsnag/client/index.js

@@ -1,2 +0,0 @@
-export * from "./api/index.js";
-export * from "./configuration.js";

package/dist/qmetry/client/tools.js

@@ -1,222 +0,0 @@
-import { QMetryToolsHandlers } from "../config/constants.js";
-import { ProjectArgsSchema, TestCaseDetailsArgsSchema, TestCaseListArgsSchema, TestCaseStepsArgsSchema, TestCaseVersionDetailsArgsSchema, } from "../types/common.js";
-export const TOOLS = [
-    {
-        title: "Set QMetry Project Info",
-        summary: "Set current QMetry project for your account",
-        handler: QMetryToolsHandlers.SET_PROJECT_INFO,
-        zodSchema: ProjectArgsSchema,
-        purpose: "Switch the active QMetry project context for the current session. " +
-            "This tool sets the default project that will be used for all subsequent QMetry operations. " +
-            "Essential for multi-project QMetry instances where you need to work with specific projects.",
-        useCases: [
-            "Switch to a specific project before performing test case operations",
-            "Set project context for batch operations on test cases",
-            "Configure the default project for the current session",
-            "Validate access to a specific project before proceeding with operations",
-        ],
-        examples: [
-            {
-                description: "Set default project as active",
-                parameters: { projectKey: "default" },
-                expectedOutput: "Project context set to 'default' with confirmation of project details",
-            },
-            {
-                description: "Switch to UT project",
-                parameters: { projectKey: "UT" },
-                expectedOutput: "Project context switched to 'UT' project with available configurations",
-            },
-            {
-                description: "Set MAC project as active for test case operations",
-                parameters: { projectKey: "MAC" },
-                expectedOutput: "Project context set to 'MAC' with viewIds and folder structure",
-            },
-        ],
-        hints: [
-            "Always set the project context before performing test case operations in multi-project environments",
-            "Use the same project key that you'll use in subsequent test case operations",
-            "Common project keys include 'default', 'UT', 'MAC', 'VT' - check with your QMetry admin for available projects",
-            "This operation must be performed before fetching test cases if working with non-default projects",
-            "The project context persists for the current session until changed again",
-        ],
-        outputFormat: "JSON object containing project configuration details, confirmation of project switch, and available project metadata",
-        readOnly: false,
-        idempotent: true,
-    },
-    {
-        title: "Fetch QMetry Project Info",
-        summary: "Fetch QMetry project information including viewId and folderPath needed for other operations",
-        handler: QMetryToolsHandlers.FETCH_PROJECT_INFO,
-        zodSchema: ProjectArgsSchema,
-        purpose: "Prerequisite tool that provides project configuration data required by other QMetry operations. " +
-            "The project key to fetch info for. Use 'default' if not specified. " +
-            "Common project keys include 'UT', 'VT', 'MAC', etc. " +
-            "If user doesn't specify a project key, this tool will use 'default' automatically.",
-        useCases: [
-            "Get project configuration before fetching test cases",
-            "Retrieve available viewIds for test case listing",
-            "Get folderPath information for project navigation",
-            "Validate project access and permissions",
-        ],
-        examples: [
-            {
-                description: "Get default project info",
-                parameters: {},
-                expectedOutput: "Project configuration with viewIds, folderPaths, and project details",
-            },
-            {
-                description: "Get specific project info",
-                parameters: { projectKey: "MAC" },
-                expectedOutput: "MAC project configuration with available views and folders",
-            },
-        ],
-        hints: [
-            "Always call this first when user doesn't provide viewId or folderPath",
-            "Use 'default' project key when user doesn't specify one",
-            "Extract viewId from latestViews.TC.viewId for test case operations",
-            "Use empty string '' as folderPath for root directory",
-        ],
-        outputFormat: "JSON object containing project details, viewIds, folderPaths, and project configuration",
-        readOnly: true,
-        idempotent: true,
-    },
-    {
-        title: "Fetch Test Cases",
-        summary: "Fetch QMetry test cases - automatically handles viewId resolution based on project",
-        handler: QMetryToolsHandlers.FETCH_TEST_CASES,
-        zodSchema: TestCaseListArgsSchema,
-        purpose: "Get test cases from QMetry. System automatically gets correct viewId from project info if not provided.",
-        useCases: [
-            "List all test cases in a project",
-            "Search for specific test cases using filters",
-            "Browse test cases in specific folders",
-            "Get paginated test case results",
-        ],
-        examples: [
-            {
-                description: "Get all test cases from default project - system will auto-fetch viewId",
-                parameters: {},
-                expectedOutput: "List of test cases from default project with auto-resolved viewId",
-            },
-            {
-                description: "Get all test cases from UT project - system will auto-fetch UT project's viewId",
-                parameters: { projectKey: "UT" },
-                expectedOutput: "List of test cases from UT project using UT's specific TC viewId",
-            },
-            {
-                description: "Get test cases with manual viewId (skip auto-resolution)",
-                parameters: { projectKey: "MAC", viewId: 167136, folderPath: "" },
-                expectedOutput: "Test cases using manually specified viewId 167136",
-            },
-            {
-                description: "List test cases from specific project (ex: project key can be anything (VT, UT, PROJ1, TEST9)",
-                parameters: {
-                    projectKey: "use specific given project key",
-                    viewId: "fetch specific project given projectKey Test Case ViewId",
-                    folderPath: "",
-                },
-                expectedOutput: "Test cases using manually specified viewId 167136 or projectKey",
-            },
-        ],
-        hints: [
-            "CRITICAL WORKFLOW: Always use the SAME projectKey for both project info and test case fetching",
-            "Step 1: If user specifies projectKey (like 'UT', 'MAC'), use that EXACT projectKey for project info",
-            "Step 2: Get project info using that projectKey, extract latestViews.TC.viewId",
-            "Step 3: Use the SAME projectKey and the extracted TC viewId for fetching test cases",
-            "Step 4: If user doesn't specify projectKey, use 'default' for both project info and test case fetching",
-            "NEVER mix project keys - if user says 'MAC project', use projectKey='MAC' for everything",
-            'For search by test case key (like MAC-TC-1684), use filter: \'[{"type":"string","value":"MAC-TC-1684","field":"entityKeyId"}]\'',
-        ],
-        outputFormat: "JSON object with 'data' array containing test cases and pagination info",
-        readOnly: true,
-        idempotent: true,
-        openWorld: false,
-    },
-    {
-        title: "Fetch Test Case Details",
-        summary: "Get detailed information for a specific QMetry test case by numeric ID",
-        handler: QMetryToolsHandlers.FETCH_TEST_CASE_DETAILS,
-        zodSchema: TestCaseDetailsArgsSchema,
-        purpose: "Retrieve comprehensive test case information including metadata, status, and basic properties",
-        useCases: [
-            "Get test case details by numeric ID",
-            "Retrieve test case metadata for reporting",
-            "Get test case summary and properties",
-            "Fetch test case details before accessing steps or version details",
-        ],
-        examples: [
-            {
-                description: "Get test case details by numeric ID",
-                parameters: { tcID: 4468020 },
-                expectedOutput: "Detailed test case information including summary, description, status",
-            },
-        ],
-        hints: [
-            "⚠️ This API requires a numeric tcID parameter",
-            "If user provides entityKey (e.g., MAC-TC-1684), first call FETCH_TEST_CASES with a filter on entityKeyId to resolve the tcID",
-            "After resolving entityKey → tcID, call this tool with the resolved numeric tcID",
-            "This tool provides metadata and properties; use FETCH_TEST_CASE_STEPS for step-level details",
-        ],
-        outputFormat: "JSON object with test case details including ID, key, summary, description, and metadata",
-        readOnly: true,
-        idempotent: true,
-    },
-    {
-        title: "Fetch Test Case Version Details",
-        summary: "Get QMetry test case details for a specific version by numeric ID",
-        handler: QMetryToolsHandlers.FETCH_TEST_CASE_VERSION_DETAILS,
-        zodSchema: TestCaseVersionDetailsArgsSchema,
-        purpose: "Retrieve version-specific information for a test case including history and changes",
-        useCases: [
-            "Get specific version details of a test case",
-            "Compare different versions of a test case",
-            "Retrieve version history information",
-            "Audit changes made across test case versions",
-        ],
-        examples: [
-            {
-                description: "Get version 2 details for test case ID 123",
-                parameters: { id: 123, version: 2 },
-                expectedOutput: "Version 2 details for test case 123",
-            },
-        ],
-        hints: [
-            "⚠️ Requires numeric ID, not entityKey",
-            "If user provides entityKey (e.g., MAC-TC-1684), first resolve it to numeric ID using FETCH_TEST_CASES",
-            "Version defaults to 1 if not specified",
-            "Provides version-specific metadata and history",
-        ],
-        outputFormat: "JSON object with version-specific test case details",
-        readOnly: true,
-        idempotent: true,
-    },
-    {
-        title: "Fetch Test Case Steps",
-        summary: "Get detailed test case steps for a specific test case by numeric ID",
-        handler: QMetryToolsHandlers.FETCH_TEST_CASE_STEPS,
-        zodSchema: TestCaseStepsArgsSchema,
-        purpose: "Retrieve step-by-step instructions and expected results for manual execution of a test case",
-        useCases: [
-            "Get step-by-step instructions with expected results",
-            "Retrieve test case execution procedure for manual runs",
-            "Export or display detailed test steps for documentation",
-            "Fetch steps before automation mapping",
-        ],
-        examples: [
-            {
-                description: "Get steps for test case ID 123",
-                parameters: { id: 123 },
-                expectedOutput: "Detailed steps with actions and expected results for test case 123",
-            },
-        ],
-        hints: [
-            "⚠️ Requires numeric ID, not entityKey",
-            "If user provides entityKey (e.g., MAC-TC-1684), resolve it first via FETCH_TEST_CASES to get the numeric ID",
-            "Version defaults to 1 if not specified",
-            "Use pagination for test cases with many steps",
-        ],
-        outputFormat: "JSON object with array of test steps including step description, expected result, and order",
-        readOnly: true,
-        idempotent: true,
-    },
-];

package/dist/zephyr/common/types.js

@@ -1,35 +0,0 @@
-import { z } from "zod";
-export const MaxResultsSchema = z
-    .number()
-    .min(1)
-    .max(1000)
-    .describe(`
-    Specifies the maximum number of results to return in a single call. The default value is 10, and the maximum value that can be requested is 1000.
-
-    Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints.
-    If this happens, the result set may be truncated. Always check the maxResults value in the response to confirm how many results were actually returned.
-  `);
-export const StartAtSchema = z
-    .number()
-    .min(0)
-    .max(1000000)
-    .describe(`
-    Zero-indexed starting position used to paginate through results. Defaults to 0.
-  `);
-export const ZephyrProjectSchema = z.object({
-    id: z.number(),
-    jiraProjectId: z.number(),
-    key: z.string(),
-    enabled: z.boolean(),
-});
-export function createListSchema(itemSchema) {
-    return z.object({
-        next: z.string().nullable(),
-        startAt: StartAtSchema,
-        maxResults: MaxResultsSchema,
-        total: z.number(),
-        isLast: z.boolean(),
-        values: z.array(itemSchema),
-    });
-}
-export const ZephyrProjectListSchema = createListSchema(ZephyrProjectSchema);