@smartbear/mcp 0.11.0 → 0.12.0

package/dist/swagger/client/registry-types.js

@@ -75,3 +75,29 @@ export const ScanStandardizationParamsSchema = z.object({
         .string()
         .describe("API definition content (OpenAPI/AsyncAPI specification in JSON or YAML format) to scan for standardization errors"),
 });
+export const CreateApiFromPromptParamsSchema = z.object({
+    owner: z
+        .string()
+        .describe("API owner (organization or user, case-sensitive)"),
+    apiName: z.string().describe("API name"),
+    prompt: z
+        .string()
+        .describe("The prompt describing the desired API functionality (e.g., 'Create a RESTful API for managing a pet store with endpoints for pets, orders, and inventory')"),
+    specType: z
+        .enum([
+        "openapi20",
+        "openapi30x",
+        "openapi31x",
+        "asyncapi2xx",
+        "asyncapi30x",
+    ])
+        .default("openapi30x")
+        .describe("Specification type for the generated API definition. Use: 'openapi20' for OpenAPI 2.0, 'openapi30x' for OpenAPI 3.0.x (default), 'openapi31x' for OpenAPI 3.1.x, 'asyncapi2xx' for AsyncAPI 2.x, 'asyncapi30x' for AsyncAPI 3.0.x"),
+});
+export const StandardizeApiParamsSchema = z.object({
+    owner: z
+        .string()
+        .describe("API owner (organization or user, case-sensitive)"),
+    api: z.string().describe("API name (case-sensitive)"),
+    version: z.string().describe("Version identifier"),
+});

package/dist/swagger/client/tools.js

@@ -5,8 +5,8 @@
  * Each tool includes parameters, descriptions, and handler method names.
  * This follows the pattern established in the pactflow module.
  */
-import { CreatePortalArgsSchema, CreateProductArgsSchema, CreateTableOfContentsArgsSchema, DeleteDocumentArgsSchema, DeleteTableOfContentsArgsSchema, GetDocumentArgsSchema, GetProductSectionsArgsSchema, GetTableOfContentsArgsSchema, PortalArgsSchema, ProductArgsSchema, PublishProductArgsSchema, UpdateDocumentArgsSchema, UpdatePortalArgsSchema, UpdateProductArgsSchema, } from "./portal-types.js";
-import { ApiDefinitionParamsSchema, ApiSearchParamsSchema, CreateApiFromTemplateParamsSchema, CreateApiParamsSchema, ScanStandardizationParamsSchema, } from "./registry-types.js";
+import { CreatePortalArgsSchema, CreateProductArgsSchema, CreateTableOfContentsArgsSchema, DeleteTableOfContentsArgsSchema, GetDocumentArgsSchema, GetProductSectionsArgsSchema, GetTableOfContentsArgsSchema, PortalArgsSchema, ProductArgsSchema, PublishProductArgsSchema, UpdateDocumentArgsSchema, UpdatePortalArgsSchema, UpdateProductArgsSchema, } from "./portal-types.js";
+import { ApiDefinitionParamsSchema, ApiSearchParamsSchema, CreateApiFromPromptParamsSchema, CreateApiFromTemplateParamsSchema, CreateApiParamsSchema, ScanStandardizationParamsSchema, StandardizeApiParamsSchema, } from "./registry-types.js";
 import { OrganizationsQuerySchema } from "./user-management-types.js";
 export const TOOLS = [
     {
@@ -27,13 +27,6 @@ export const TOOLS = [
         inputSchema: PortalArgsSchema,
         handler: "getPortal",
     },
-    {
-        title: "Delete Portal",
-        summary: "Delete a specific portal.",
-        inputSchema: PortalArgsSchema,
-        handler: "deletePortal",
-        formatResponse: () => "Portal deleted successfully.",
-    },
     {
         title: "Update Portal",
         summary: "Update a specific portal's configuration.",
@@ -114,12 +107,6 @@ export const TOOLS = [
         inputSchema: UpdateDocumentArgsSchema,
         handler: "updateDocument",
     },
-    {
-        title: "Delete Document",
-        summary: "Delete a document by its ID. This will permanently remove the document content.",
-        inputSchema: DeleteDocumentArgsSchema,
-        handler: "deleteDocument",
-    },
     // Registry API tools for SwaggerHub Design functionality
     {
         title: "Search APIs and Domains",
@@ -154,8 +141,20 @@ export const TOOLS = [
     },
     {
         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.",
+        summary: "Run a standardization scan against an API definition using the organization's governance and standardization rules. Accepts a YAML or JSON OpenAPI/AsyncAPI definition and returns a list of standardization errors and validation issues. Use this tool when users ask to validate, scan, or check API governance or standardization.",
         inputSchema: ScanStandardizationParamsSchema,
         handler: "scanStandardization",
     },
+    {
+        title: "Create API from Prompt using SmartBear AI",
+        summary: "Generate and save an API definition based on a prompt using SmartBear AI. This tool automatically applies organization governance and standardization rules during API generation. The specType parameter determines the format of the generated definition. Use: 'openapi20' for OpenAPI 2.0, 'openapi30x' for OpenAPI 3.0.x, 'openapi31x' for OpenAPI 3.1.x, 'asyncapi2xx' for AsyncAPI 2.x, 'asyncapi30x' for AsyncAPI 3.0.x. Use this tool when creating APIs that comply with governance policies or when generating APIs from natural language descriptions. Use this tool when users ask to create, generate, or design APIs with governance or standardization requirements. 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.",
+        inputSchema: CreateApiFromPromptParamsSchema,
+        handler: "createApiFromPrompt",
+    },
+    {
+        title: "Standardize API",
+        summary: "Standardize and fix an API definition using AI to ensure compliance with governance policies. Scans the API definition for standardization errors and automatically fixes them using SmartBear AI. If errors are found, they will be sent to SmartBear AI to generate a corrected definition, which is then saved back to the registry. Returns the number of errors found and the fixed definition if successful. Use this tool when users ask to standardize, fix, govern, or ensure governance compliance of APIs.",
+        inputSchema: StandardizeApiParamsSchema,
+        handler: "standardizeApi",
+    },
 ];

package/dist/swagger/client.js

@@ -32,9 +32,6 @@ export class SwaggerClient {
     async getPortal(args) {
         return this.getApi().getPortal(args.portalId);
     }
-    async deletePortal(args) {
-        return this.getApi().deletePortal(args.portalId);
-    }
     async updatePortal(args) {
         const { portalId, ...body } = args;
         return this.getApi().updatePortal(portalId, body);
@@ -77,9 +74,6 @@ export class SwaggerClient {
     async updateDocument(args) {
         return this.getApi().updateDocument(args);
     }
-    async deleteDocument(args) {
-        return this.getApi().deleteDocument(args);
-    }
     async deleteTableOfContents(args) {
         return this.getApi().deleteTableOfContents(args);
     }
@@ -100,9 +94,15 @@ export class SwaggerClient {
     async getOrganizations(args) {
         return this.getApi().getOrganizations(args);
     }
+    async createApiFromPrompt(args) {
+        return this.getApi().createApiFromPrompt(args);
+    }
     async scanStandardization(args) {
         return this.getApi().scanStandardization(args);
     }
+    async standardizeApi(args) {
+        return this.getApi().standardizeApi(args);
+    }
     registerTools(register, _getInput) {
         TOOLS.forEach((tool) => {
             const { handler, formatResponse, ...toolParams } = tool;

package/dist/tests/unit/bugsnag/utils/factories.js

@@ -0,0 +1,86 @@
+export function getMockOrganization(id, name, slug, extra = {}) {
+    return {
+        id,
+        name,
+        slug: slug ?? name.toLowerCase().replace(/\s+/g, "-"),
+        updatedAt: new Date(),
+        createdAt: new Date(),
+        autoUpgrade: false,
+        managedByPlatformServices: false,
+        ...extra,
+    };
+}
+export function getMockProject(id, name, apiKey, extra = {}) {
+    return { id, name, apiKey, ...extra };
+}
+export function getMockEventField(displayId, extra = {}) {
+    return {
+        displayId: displayId,
+        custom: false,
+        filterOptions: { name: "filter" },
+        pivotOptions: {},
+        ...extra,
+    };
+}
+export function getMockError(id, extra = {}) {
+    return { id, ...extra };
+}
+export function getMockEvent(id, extra = {}) {
+    return { id, ...extra };
+}
+export function getMockReleaseGroup(id, extra = {}) {
+    return {
+        id,
+        projectId: "proj-1",
+        releaseStageName: "production",
+        appVersion: "1.0.0",
+        firstReleasedAt: new Date().toISOString(),
+        firstReleaseId: "release-1",
+        releasesCount: 1,
+        hasSecondaryVersions: false,
+        totalSessionsCount: 0,
+        topReleaseGroup: false,
+        visible: true,
+        ...extra,
+    };
+}
+export function getMockRelease(id, extra = {}) {
+    return { id, ...extra };
+}
+export function getMockSpanGroup(id, name, category, extra = {}) {
+    return {
+        id: `span-group-${id}`,
+        name: `span-name-${name}`,
+        displayName: name,
+        category: category,
+        ...extra,
+    };
+}
+export function getMockSpan(traceId, id, name, category, isFirstClass = true, extra = {}) {
+    return {
+        traceId,
+        id: `span-${id}`,
+        name: `span-name-${name}`,
+        displayName: name,
+        category: category,
+        isFirstClass: isFirstClass,
+        duration: Math.round(Math.random() * 1000),
+        timestamp: new Date(Date.now()).toISOString(),
+        startTime: new Date(Date.now() - 1000).toISOString(),
+        timeAdjustmentType: "unadjusted",
+        ...extra,
+    };
+}
+export function getMockTrace(name, type) {
+    return {
+        displayId: name,
+        fieldType: type,
+        filterOptions: {
+            name: name,
+            description: "Cached field",
+            searchable: true,
+            matchTypes: ["eq"],
+        },
+        custom: true,
+    };
+}

package/dist/zephyr/client.js

@@ -1,5 +1,6 @@
 import z from "zod";
 import { ApiClient } from "./common/api-client.js";
+import { GetEnvironments } from "./tool/environment/get-environments.js";
 import { GetPriorities } from "./tool/priority/get-priorities.js";
 import { GetProject } from "./tool/project/get-project.js";
 import { GetProjects } from "./tool/project/get-projects.js";
@@ -9,6 +10,7 @@ import { GetTestCases } from "./tool/test-case/get-test-cases.js";
 import { GetTestCycle } from "./tool/test-cycle/get-test-cycle.js";
 import { GetTestCycles } from "./tool/test-cycle/get-test-cycles.js";
 import { GetTestExecution } from "./tool/test-execution/get-test-execution.js";
+import { GetTestExecutions } from "./tool/test-execution/get-test-executions.js";
 const BASE_URL_DEFAULT = "https://api.zephyrscale.smartbear.com/v2";
 const ConfigurationSchema = z.object({
     api_token: z.string().describe("Zephyr Scale API token for authentication"),
@@ -44,8 +46,10 @@ export class ZephyrClient {
             new GetPriorities(apiClient),
             new GetStatuses(apiClient),
             new GetTestCases(apiClient),
+            new GetEnvironments(apiClient),
             new GetTestCase(apiClient),
             new GetTestExecution(apiClient),
+            new GetTestExecutions(apiClient),
         ];
         for (const tool of tools) {
             register(tool.specification, tool.handle);

package/dist/zephyr/tool/environment/get-environments.js

@@ -0,0 +1,68 @@
+import { listEnvironmentsQueryParams, listEnvironmentsResponse, } from "../../common/rest-api-schemas.js";
+export class GetEnvironments {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Environments",
+        summary: "Get environments in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listEnvironmentsQueryParams,
+        outputSchema: listEnvironmentsResponse,
+        examples: [
+            {
+                description: "Get the first 20 Environments",
+                parameters: {
+                    maxResults: 20,
+                    startAt: 0,
+                },
+                expectedOutput: "The first 20 Environments with their details from different projects",
+            },
+            {
+                description: "Get the first 10 Environments from the project with projectKey TEST",
+                parameters: {
+                    projectKey: "TEST",
+                    maxResults: 10,
+                    startAt: 0,
+                },
+                expectedOutput: "The first 10 Environments with their details from project with projectKey TEST",
+            },
+            {
+                description: "Get second 10 Environments from the project with projectKey TEST",
+                parameters: {
+                    projectKey: "TEST",
+                    maxResults: 10,
+                    startAt: 10,
+                },
+                expectedOutput: "The second 10 Environments with their details from project with projectKey TEST",
+            },
+            {
+                description: "Get Environments starting from the 5th Environment from different projects",
+                parameters: {
+                    startAt: 5,
+                    maxResults: 10,
+                },
+                expectedOutput: "Environments starting from the 5th one with their details from different projects",
+            },
+            {
+                description: "Get 5 Environments starting from the 10th Environment from the project with projectKey PROJ",
+                parameters: {
+                    startAt: 10,
+                    maxResults: 5,
+                    projectKey: "PROJ",
+                },
+                expectedOutput: "The five environments starting from the 10th Environment from the project PROJ with their details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const getEnvironmentsInput = listEnvironmentsQueryParams.parse(args);
+        const response = await this.apiClient.get("/environments", getEnvironmentsInput);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

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

@@ -0,0 +1,45 @@
+import { listTestExecutionsNextgenQueryParams, listTestExecutionsNextgenResponse, } from "../../common/rest-api-schemas.js";
+export class GetTestExecutions {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Test Executions",
+        summary: "Get test executions with optional filters",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listTestExecutionsNextgenQueryParams,
+        outputSchema: listTestExecutionsNextgenResponse,
+        examples: [
+            {
+                description: "Get the first 10 test executions",
+                parameters: { limit: 10, startAtId: 0 },
+                expectedOutput: "The first 10 test executions with their details",
+            },
+            {
+                description: "Get 5 test executions for the project PROJ",
+                parameters: { projectKey: "PROJ", limit: 5 },
+                expectedOutput: "Up to 5 test executions for project PROJ",
+            },
+            {
+                description: "Get some test executions that finished after 01/Jan/2024",
+                parameters: { actualEndDateAfter: "2024-01-01T00:00:00Z" },
+                expectedOutput: "Test executions that ended after 2024-01-01",
+            },
+            {
+                description: "Get test executions with step links included",
+                parameters: { includeStepLinks: true },
+                expectedOutput: "Test executions with step links included",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const parsedArgs = listTestExecutionsNextgenQueryParams.parse(args);
+        const response = await this.apiClient.get("/testexecutions/nextgen", parsedArgs);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartbear/mcp",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "MCP server for interacting SmartBear Products",
   "keywords": [
     "smartbear",
@@ -43,7 +43,8 @@
     "test:coverage": "vitest --coverage",
     "test:coverage:ci": "vitest --coverage --reporter=verbose",
     "test:run": "vitest run",
-    "coverage:check": "vitest --coverage --reporter=verbose --config vitest.config.coverage.ts"
+    "coverage:check": "vitest --coverage --reporter=verbose --config vitest.config.coverage.ts",
+    "bump": "node scripts/bump.js"
   },
   "dependencies": {
     "@bugsnag/js": "^8.2.0",