@smartbear/mcp 0.5.0 → 0.7.0

package/dist/qmetry/client.js

@@ -0,0 +1,95 @@
+import { QMETRY_HANDLER_MAP } from "./client/handlers.js";
+import { getProjectInfo } from "./client/project.js";
+import { TOOLS } from "./client/tools.js";
+import { QMETRY_DEFAULTS, QMetryToolsHandlers } from "./config/constants.js";
+export class QmetryClient {
+    name = "QMetry";
+    prefix = "qmetry";
+    token;
+    projectApiKey;
+    endpoint;
+    constructor(token, endpoint) {
+        this.token = token;
+        this.projectApiKey = QMETRY_DEFAULTS.PROJECT_KEY;
+        this.endpoint = endpoint || QMETRY_DEFAULTS.BASE_URL;
+    }
+    getToken() {
+        return this.token;
+    }
+    getBaseUrl() {
+        return this.endpoint;
+    }
+    registerTools(register, _getInput) {
+        const resolveContext = (args) => ({
+            baseUrl: args.baseUrl ?? this.endpoint,
+            projectKey: args.projectKey ?? this.projectApiKey,
+        });
+        const handleAsync = async (fn) => {
+            try {
+                return await fn();
+            }
+            catch (err) {
+                return {
+                    content: [
+                        {
+                            success: false,
+                            type: "text",
+                            text: `Error: ${err instanceof Error ? err.message : String(err)}`,
+                        },
+                    ],
+                };
+            }
+        };
+        for (const tool of TOOLS) {
+            const handlerFn = QMETRY_HANDLER_MAP[tool.handler];
+            if (!handlerFn) {
+                console.error(`⚠️ No handler mapped for ${tool.title}`);
+                continue;
+            }
+            register(tool, (args) => handleAsync(async () => {
+                const a = args;
+                const { baseUrl, projectKey } = resolveContext(a);
+                // handling for FETCH_TEST_CASES to auto-resolve viewId and folderPath
+                if (tool.handler === QMetryToolsHandlers.FETCH_TEST_CASES) {
+                    let viewId = a.viewId;
+                    let folderPath = a.folderPath;
+                    if (!viewId || folderPath === undefined) {
+                        let projectInfo;
+                        try {
+                            projectInfo = (await getProjectInfo(this.token, baseUrl, projectKey));
+                        }
+                        catch (err) {
+                            throw new Error(`Failed to auto-resolve viewId/folderPath for project ${projectKey}. ` +
+                                `Please provide them manually or check project access. ` +
+                                `Error: ${err instanceof Error ? err.message : String(err)}`);
+                        }
+                        if (!viewId && projectInfo?.latestViews?.TC?.viewId) {
+                            viewId = projectInfo.latestViews.TC.viewId;
+                        }
+                        if (folderPath === undefined) {
+                            folderPath = "";
+                        }
+                    }
+                    a.viewId = viewId;
+                    a.folderPath = folderPath;
+                }
+                const result = await handlerFn(this.token, baseUrl, projectKey, a);
+                // Use custom formatter if available, otherwise return JSON
+                const formatted = tool.formatResponse
+                    ? tool.formatResponse(result)
+                    : (result ?? {});
+                return {
+                    content: [
+                        {
+                            success: true,
+                            type: "text",
+                            text: typeof formatted === "string"
+                                ? formatted
+                                : JSON.stringify(formatted, null, 2),
+                        },
+                    ],
+                };
+            }));
+        }
+    }
+}

package/dist/qmetry/config/constants.js

@@ -0,0 +1,12 @@
+export const QMETRY_DEFAULTS = {
+    BASE_URL: "https://testmanagement.qmetry.com",
+    PROJECT_KEY: "default",
+};
+export const QMetryToolsHandlers = {
+    SET_PROJECT_INFO: "setProjectInfo",
+    FETCH_PROJECT_INFO: "getProjectInfo",
+    FETCH_TEST_CASES: "getTestCases",
+    FETCH_TEST_CASE_DETAILS: "getTestCaseDetails",
+    FETCH_TEST_CASE_VERSION_DETAILS: "getTestCaseVersionDetails",
+    FETCH_TEST_CASE_STEPS: "getTestCaseSteps",
+};

package/dist/qmetry/config/rest-endpoints.js

@@ -0,0 +1,11 @@
+export const QMETRY_PATHS = {
+    PROJECT: {
+        GET_INFO: "/rest/admin/project/getinfo",
+    },
+    TESTCASE: {
+        GET_TC_LIST: "/rest/testcases/list/viewColumns",
+        GET_TC_DETAILS: "/rest/testcases/getVersionDetail",
+        GET_TC_DETAILS_BY_VERSION: "/rest/testcases/list",
+        GET_TC_STEPS: "/rest/testcases/steps/list",
+    },
+};

package/dist/qmetry/types/common.js

@@ -0,0 +1,174 @@
+import { z } from "zod";
+import { QMETRY_DEFAULTS } from "../config/constants.js";
+export const DEFAULT_PAGINATION = {
+    start: 0,
+    page: 1,
+    limit: 10,
+};
+export const DEFAULT_FILTER = {
+    filter: "[]",
+};
+export const DEFAULT_FOLDER_OPTIONS = {
+    scope: "project",
+    showRootOnly: false,
+    getSubEntities: true,
+    hideEmptyFolders: false,
+    folderSortColumn: "name",
+    folderSortOrder: "ASC",
+    restoreDefaultColumns: false,
+    folderID: null,
+};
+// Reusable Zod schema components
+export const CommonFields = {
+    projectKey: z
+        .string()
+        .describe("Project key - unique identifier for the project")
+        .default(QMETRY_DEFAULTS.PROJECT_KEY),
+    projectKeyOptional: z
+        .string()
+        .optional()
+        .describe("Project key - unique identifier for the project")
+        .default(QMETRY_DEFAULTS.PROJECT_KEY),
+    baseUrl: z
+        .string()
+        .url()
+        .optional()
+        .describe("The base URL for the QMetry instance (must be a valid URL)")
+        .default(QMETRY_DEFAULTS.BASE_URL),
+    start: z
+        .number()
+        .optional()
+        .describe("Start index for pagination - defaults to 0")
+        .default(0),
+    page: z
+        .number()
+        .optional()
+        .describe("Page number to return (starts from 1)")
+        .default(1),
+    limit: z
+        .number()
+        .optional()
+        .describe("Number of records (default 10).")
+        .default(10),
+    tcID: z
+        .number()
+        .describe("Test Case numeric ID (required for fetching specific test case details). " +
+        "This is the internal numeric identifier, not the entity key like 'MAC-TC-1684'. " +
+        "You can get this ID from test case search results or by using filters."),
+    id: z
+        .number()
+        .describe("Test Case numeric ID (required for fetching steps or version details). " +
+        "This is the internal numeric identifier, not the entity key like 'MAC-TC-1684'. " +
+        "You can get this ID from test case search results."),
+    version: z
+        .number()
+        .describe("Test Case version number (required for fetching specific test case version details). " +
+        "This is the internal numeric identifier for the version."),
+    versionOptional: z
+        .number()
+        .optional()
+        .describe("Test Case version number (optional, defaults to 1). " +
+        "This is the internal numeric identifier for the version."),
+    viewId: z
+        .number()
+        .describe("ViewId for test cases - SYSTEM AUTOMATICALLY RESOLVES THIS. " +
+        "Leave empty unless you have a specific viewId. " +
+        "System will fetch project info using the projectKey and extract latestViews.TC.viewId automatically. " +
+        "Manual viewId only needed if you want to override the automatic resolution."),
+    folderPath: z
+        .string()
+        .optional()
+        .describe("Folder path for test cases - SYSTEM AUTOMATICALLY SETS TO ROOT. " +
+        'Leave empty unless you want specific folder. System will automatically use "" (root directory). ' +
+        'Only specify if user wants specific folder like "Automation/Regression".')
+        .default(""),
+    folderID: z
+        .number()
+        .optional()
+        .describe("Folder ID for test cases - unique identifier for the folder containing test cases"),
+    scope: z
+        .string()
+        .optional()
+        .describe("Scope of the test cases (default 'project')")
+        .default("project"),
+    filter: z
+        .string()
+        .optional()
+        .describe("Filter criteria as JSON string (default '[]')")
+        .default("[]"),
+    udfFilter: z
+        .string()
+        .optional()
+        .describe("User-defined field filter as JSON string (default '[]')")
+        .default("[]"),
+    showRootOnly: z
+        .boolean()
+        .optional()
+        .describe("Whether to show only root folders."),
+    getSubEntities: z
+        .boolean()
+        .optional()
+        .describe("Whether to include sub-entities."),
+    hideEmptyFolders: z
+        .boolean()
+        .optional()
+        .describe("Whether to hide empty folders."),
+    folderSortColumn: z
+        .string()
+        .optional()
+        .describe("Folder sort column (default 'name')"),
+    restoreDefaultColumns: z
+        .boolean()
+        .optional()
+        .describe("Whether to restore default columns (default 'false')"),
+    folderSortOrder: z
+        .string()
+        .optional()
+        .describe("Folder sort order (ASC or DESC)"),
+};
+export const ProjectArgsSchema = z.object({
+    projectKey: CommonFields.projectKey,
+});
+export const TestCaseListArgsSchema = z.object({
+    projectKey: CommonFields.projectKeyOptional,
+    baseUrl: CommonFields.baseUrl,
+    viewId: CommonFields.viewId,
+    folderPath: CommonFields.folderPath,
+    folderID: CommonFields.folderID,
+    start: CommonFields.start,
+    page: CommonFields.page,
+    limit: CommonFields.limit,
+    scope: CommonFields.scope,
+    showRootOnly: CommonFields.showRootOnly,
+    getSubEntities: CommonFields.getSubEntities,
+    hideEmptyFolders: CommonFields.hideEmptyFolders,
+    folderSortColumn: CommonFields.folderSortColumn,
+    restoreDefaultColumns: CommonFields.restoreDefaultColumns,
+    folderSortOrder: CommonFields.folderSortOrder,
+    filter: CommonFields.filter,
+    udfFilter: CommonFields.udfFilter,
+});
+export const TestCaseDetailsArgsSchema = z.object({
+    projectKey: CommonFields.projectKeyOptional,
+    baseUrl: CommonFields.baseUrl,
+    tcID: CommonFields.tcID,
+    start: CommonFields.start,
+    page: CommonFields.page,
+    limit: CommonFields.limit,
+});
+export const TestCaseVersionDetailsArgsSchema = z.object({
+    projectKey: CommonFields.projectKeyOptional,
+    baseUrl: CommonFields.baseUrl,
+    id: CommonFields.id,
+    version: CommonFields.version,
+    scope: CommonFields.scope,
+});
+export const TestCaseStepsArgsSchema = z.object({
+    projectKey: CommonFields.projectKeyOptional,
+    baseUrl: CommonFields.baseUrl,
+    id: CommonFields.id,
+    version: CommonFields.versionOptional,
+    start: CommonFields.start,
+    page: CommonFields.page,
+    limit: CommonFields.limit,
+});

package/dist/qmetry/types/testcase.js

@@ -0,0 +1,19 @@
+import { DEFAULT_FILTER, DEFAULT_FOLDER_OPTIONS, DEFAULT_PAGINATION, } from "./common.js";
+export const DEFAULT_FETCH_TESTCASES_PAYLOAD = {
+    ...DEFAULT_PAGINATION,
+    ...DEFAULT_FILTER,
+    ...DEFAULT_FOLDER_OPTIONS,
+    udfFilter: "[]",
+};
+export const DEFAULT_FETCH_TESTCASE_DETAILS_PAYLOAD = {
+    ...DEFAULT_PAGINATION,
+    ...DEFAULT_FILTER,
+};
+export const DEFAULT_FETCH_TESTCASE_VERSION_DETAILS_PAYLOAD = {
+    ...DEFAULT_FILTER,
+    scope: DEFAULT_FOLDER_OPTIONS.scope,
+};
+export const DEFAULT_FETCH_TESTCASE_STEPS_PAYLOAD = {
+    ...DEFAULT_PAGINATION,
+    version: 1,
+};

package/dist/reflect/client.js

@@ -1,5 +1,5 @@
-import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
 import { z } from "zod";
+import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
 // ReflectClient class implementing the Client interface
 export class ReflectClient {
     headers;
@@ -61,7 +61,7 @@ export class ReflectClient {
         });
         return response.json();
     }
-    async getReflectTestStatus(testId, executionId) {
+    async getReflectTestStatus(_testId, executionId) {
         const response = await fetch(`https://api.reflect.run/v1/executions/${executionId}`, {
             method: "GET",
             headers: this.headers,
@@ -87,7 +87,7 @@ export class ReflectClient {
                     name: "suiteId",
                     type: z.string(),
                     description: "ID of the reflect suite to list executions for",
-                    required: true
+                    required: true,
                 },
             ],
         }, async (args, _extra) => {
@@ -106,13 +106,13 @@ export class ReflectClient {
                     name: "suiteId",
                     type: z.string(),
                     description: "ID of the reflect suite to get execution status for",
-                    required: true
+                    required: true,
                 },
                 {
                     name: "executionId",
                     type: z.string(),
                     description: "ID of the reflect suite execution to get status for",
-                    required: true
+                    required: true,
                 },
             ],
         }, async (args, _extra) => {
@@ -131,9 +131,9 @@ export class ReflectClient {
                     name: "suiteId",
                     type: z.string(),
                     description: "ID of the reflect suite to list executions for",
-                    required: true
-                }
-            ]
+                    required: true,
+                },
+            ],
         }, async (args, _extra) => {
             if (!args.suiteId)
                 throw new Error("suiteId argument is required");
@@ -150,13 +150,13 @@ export class ReflectClient {
                     name: "suiteId",
                     type: z.string(),
                     description: "ID of the reflect suite to cancel execution for",
-                    required: true
+                    required: true,
                 },
                 {
                     name: "executionId",
                     type: z.string(),
                     description: "ID of the reflect suite execution to cancel",
-                    required: true
+                    required: true,
                 },
             ],
         }, async (args, _extra) => {
@@ -185,8 +185,8 @@ export class ReflectClient {
                     name: "testId",
                     type: z.string(),
                     description: "ID of the reflect test to run",
-                    required: true
-                }
+                    required: true,
+                },
             ],
         }, async (args, _extra) => {
             if (!args.testId)
@@ -204,13 +204,13 @@ export class ReflectClient {
                     name: "testId",
                     type: z.string(),
                     description: "ID of the reflect test to run",
-                    required: true
+                    required: true,
                 },
                 {
                     name: "executionId",
                     type: z.string(),
                     description: "ID of the reflect test execution to get status for",
-                    required: true
+                    required: true,
                 },
             ],
         }, async (args, _extra) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartbear/mcp",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "MCP server for interacting SmartBear Products",
   "keywords": [
     "smartbear",
@@ -11,6 +11,7 @@
     "pactflow"
   ],
   "homepage": "https://developer.smartbear.com/smartbear-mcp",
+  "mcpName": "com.smartbear/smartbear-mcp",
   "repository": {
     "type": "git",
     "url": "git@github.com:SmartBear/smartbear-mcp.git"
@@ -30,7 +31,10 @@
   },
   "scripts": {
     "build": "tsc && shx chmod +x dist/*.js",
-    "lint": "eslint . --ext .ts",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint . --fix",
+    "format": "biome format . --write",
+    "format:check": "biome format .",
     "prepare": "npm run build",
     "watch": "tsc --watch",
     "test": "vitest",
@@ -45,18 +49,17 @@
     "@modelcontextprotocol/sdk": "^1.15.0",
     "node-cache": "^5.1.2",
     "swagger-client": "^3.35.6",
-    "zod": "^3"
+    "zod": "^3",
+    "zod-to-json-schema": "^3.24.6"
   },
   "devDependencies": {
-    "@eslint/js": "^9.29.0",
+    "@biomejs/biome": "^2.2.4",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^22",
     "@vitest/coverage-v8": "^3.2.4",
-    "eslint": "^9.29.0",
     "globals": "^16.2.0",
     "shx": "^0.3.4",
     "typescript": "^5.6.2",
-    "typescript-eslint": "^8.34.1",
     "vitest": "^3.2.4",
     "vitest-fetch-mock": "^0.4.5"
   }