@smartbear/mcp 0.5.0 → 0.7.0

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

@@ -0,0 +1,86 @@
+/**
+ * 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, } 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",
+    },
+];

package/dist/api-hub/client.js

@@ -1,429 +1,89 @@
-import { z } from "zod";
 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 {
-    headers;
+    config;
+    api;
     name = "API Hub";
     prefix = "api_hub";
     constructor(token) {
-        this.headers = {
-            "Authorization": `Bearer ${token}`,
-            "Content-Type": "application/json",
-            "User-Agent": `${MCP_SERVER_NAME}/${MCP_SERVER_VERSION}`,
-        };
+        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() {
-        const response = await fetch("https://api.portal.swaggerhub.com/v1/portals", {
-            method: "GET",
-            headers: this.headers,
-        });
-        return response.json();
+        return this.api.getPortals();
     }
     async createPortal(body) {
-        const response = await fetch(`https://api.portal.swaggerhub.com/v1/portals`, {
-            method: "POST",
-            headers: this.headers,
-            body: JSON.stringify(body),
-        });
-        return response.json();
+        return this.api.createPortal(body);
     }
-    async getPortal(portalId) {
-        const response = await fetch(`https://api.portal.swaggerhub.com/v1/portals/${portalId}`, {
-            method: "GET",
-            headers: this.headers,
-        });
-        return response.json();
+    async getPortal(args) {
+        return this.api.getPortal(args.portalId);
     }
-    async deletePortal(portalId) {
-        await fetch(`https://api.portal.swaggerhub.com/v1/portals/${portalId}`, {
-            method: "DELETE",
-            headers: this.headers,
-        });
+    async deletePortal(args) {
+        return this.api.deletePortal(args.portalId);
     }
-    async updatePortal(portalId, body) {
-        const response = await fetch(`https://api.portal.swaggerhub.com/v1/portals/${portalId}`, {
-            method: "PATCH",
-            headers: this.headers,
-            body: JSON.stringify(body),
-        });
-        return response.json();
+    async updatePortal(args) {
+        const { portalId, ...body } = args;
+        return this.api.updatePortal(portalId, body);
     }
-    async getPortalProducts(portalId) {
-        const response = await fetch(`https://api.portal.swaggerhub.com/v1/portals/${portalId}/products`, {
-            method: "GET",
-            headers: this.headers,
-        });
-        return response.json();
+    async getPortalProducts(args) {
+        return this.api.getPortalProducts(args.portalId);
     }
-    async createPortalProduct(portalId, body) {
-        const response = await fetch(`https://api.portal.swaggerhub.com/v1/portals/${portalId}/products`, {
-            method: "POST",
-            headers: this.headers,
-            body: JSON.stringify(body),
-        });
-        return response.json();
+    async createPortalProduct(args) {
+        const { portalId, ...body } = args;
+        return this.api.createPortalProduct(portalId, body);
     }
-    async getPortalProduct(productId) {
-        const response = await fetch(`https://api.portal.swaggerhub.com/v1/products/${productId}`, {
-            method: "GET",
-            headers: this.headers,
-        });
-        return response.json();
+    async getPortalProduct(args) {
+        return this.api.getPortalProduct(args.productId);
     }
-    async deletePortalProduct(productId) {
-        await fetch(`https://api.portal.swaggerhub.com/v1/products/${productId}`, {
-            method: "DELETE",
-            headers: this.headers,
-        });
+    async deletePortalProduct(args) {
+        return this.api.deletePortalProduct(args.productId);
     }
-    async updatePortalProduct(productId, body) {
-        const response = await fetch(`https://api.portal.swaggerhub.com/v1/products/${productId}`, {
-            method: "PATCH",
-            headers: this.headers,
-            body: JSON.stringify(body),
-        });
-        return response.json();
+    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);
     }
     registerTools(register, _getInput) {
-        register({
-            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: [],
-        }, async (_args, _extra) => {
-            const response = await this.getPortals();
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
-        });
-        register({
-            title: "Create Portal",
-            summary: "Create a new portal within API Hub.",
-            parameters: [
-                {
-                    name: "name",
-                    type: z.string(),
-                    required: false,
-                    description: "The portal name.",
-                },
-                {
-                    name: "subdomain",
-                    type: z.string(),
-                    required: true,
-                    description: "The portal subdomain.",
-                },
-                {
-                    name: "offline",
-                    type: z.boolean(),
-                    required: false,
-                    description: "If set to true the portal will not be visible to customers.",
-                },
-                {
-                    name: "routing",
-                    type: z.string(),
-                    required: false,
-                    description: "Determines the routing strategy ('browser' or 'proxy').",
-                },
-                {
-                    name: "credentialsEnabled",
-                    type: z.string(),
-                    required: false,
-                    description: "Indicates if credentials are enabled for the portal.",
-                },
-                {
-                    name: "swaggerHubOrganizationId",
-                    type: z.string(),
-                    required: true,
-                    description: "The corresponding API Hub (formerly SwaggerHub) organization UUID.",
-                },
-                {
-                    name: "openapiRenderer",
-                    type: z.string(),
-                    required: false,
-                    description: "Portal level setting for the OpenAPI renderer. SWAGGER_UI - Use the Swagger UI renderer. ELEMENTS - Use the Elements renderer. TOGGLE - Switch between the two renderers with elements set as the default.",
-                },
-                {
-                    name: "pageContentFormat",
-                    type: z.string(),
-                    required: false,
-                    description: "The format of the page content.",
+        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 }],
+                    };
                 }
-            ],
-        }, async (args, _extra) => {
-            const createPortalArgs = args;
-            const response = await this.createPortal(createPortalArgs);
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
-        });
-        register({
-            title: "Get Portal",
-            summary: "Retrieve information about a specific portal.",
-            parameters: [
-                {
-                    name: "portalId",
-                    type: z.string(),
-                    description: "Portal UUID or subdomain.",
-                    required: true
-                },
-            ],
-        }, async (args, _extra) => {
-            const portalArgs = args;
-            const response = await this.getPortal(portalArgs.portalId);
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
-        });
-        register({
-            title: "Delete Portal",
-            summary: "Delete a specific portal.",
-            parameters: [
-                {
-                    name: "portalId",
-                    type: z.string(),
-                    description: "Portal UUID or subdomain.",
-                    required: true
-                }
-            ],
-        }, async (args, _extra) => {
-            const portalArgs = args;
-            await this.deletePortal(portalArgs.portalId);
-            return {
-                content: [{ type: "text", text: "Portal deleted successfully." }],
-            };
-        });
-        register({
-            title: "Update Portal",
-            summary: "Update a specific portal's configuration.",
-            parameters: [
-                {
-                    name: "portalId",
-                    type: z.string(),
-                    description: "Portal UUID or subdomain.",
-                    required: true
-                },
-                {
-                    name: "name",
-                    type: z.string(),
-                    description: "The portal name.",
-                    required: false
-                },
-                {
-                    name: "subdomain",
-                    type: z.string(),
-                    description: "The portal subdomain.",
-                    required: false
-                },
-                {
-                    name: "customDomain",
-                    type: z.boolean(),
-                    description: "Indicates if the portal has a custom domain.",
-                    required: false
-                },
-                {
-                    name: "gtmKey",
-                    type: z.string(),
-                    description: "Google Tag Manager key for the portal.",
-                    required: false
-                },
-                {
-                    name: "offline",
-                    type: z.boolean(),
-                    description: "If set to true the portal will not be visible to customers.",
-                    required: false
-                },
-                {
-                    name: "routing",
-                    type: z.string(),
-                    description: "Determines the routing strategy ('browser' or 'proxy').",
-                    required: false
-                },
-                {
-                    name: "credentialsEnabled",
-                    type: z.boolean(),
-                    description: "Indicates if credentials are enabled for the portal.",
-                    required: false
-                },
-                {
-                    name: "openapiRenderer",
-                    type: z.string(),
-                    description: "Portal level setting for the OpenAPI renderer. SWAGGER_UI - Use the Swagger UI renderer. ELEMENTS - Use the Elements renderer. TOGGLE - Switch between the two renderers with elements set as the default.",
-                    required: false
-                },
-                {
-                    name: "pageContentFormat",
-                    type: z.string(),
-                    description: "The format of the page content.",
-                    required: false
-                }
-            ],
-        }, async (args, _extra) => {
-            const updatePortalArgs = args;
-            const response = await this.updatePortal(updatePortalArgs.portalId, updatePortalArgs);
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
-        });
-        register({
-            title: "List Portal Products",
-            summary: "Get products for a specific portal that match your criteria.",
-            parameters: [
-                {
-                    name: "portalId",
-                    type: z.string(),
-                    description: "Portal UUID or subdomain.",
-                    required: true
-                }
-            ],
-        }, async (args, _extra) => {
-            const portalArgs = args;
-            const response = await this.getPortalProducts(portalArgs.portalId);
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
-        });
-        register({
-            title: "Create Portal Product",
-            summary: "Create a new product for a specific portal.",
-            parameters: [
-                {
-                    name: "portalId",
-                    type: z.string(),
-                    description: "Portal UUID or subdomain.",
-                    required: true
-                },
-                {
-                    name: "type",
-                    type: z.string(),
-                    description: "Product type (Allowed values: 'new', 'copy').",
-                    required: true
-                },
-                {
-                    name: "name",
-                    type: z.string(),
-                    description: "Product name.",
-                    required: true
-                },
-                {
-                    name: "slug",
-                    type: z.string(),
-                    description: "URL component for this product. Must be unique within the portal.",
-                    required: true
-                },
-                {
-                    name: "description",
-                    type: z.string(),
-                    description: "Product description.",
-                    required: false
-                },
-                {
-                    name: "public",
-                    type: z.boolean(),
-                    description: "Indicates if the product is public.",
-                    required: false
-                },
-                {
-                    name: "hidden",
-                    type: z.string(),
-                    description: "Indicates if the product is hidden.",
-                    required: false
-                },
-                {
-                    name: "role",
-                    type: z.boolean(),
-                    description: "Indicates if the product has a role.",
-                    required: false
-                }
-            ],
-        }, async (args, _extra) => {
-            const createProductArgs = args;
-            const response = await this.createPortalProduct(createProductArgs.portalId, createProductArgs);
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
-        });
-        register({
-            title: "Get Portal Product",
-            summary: "Retrieve information about a specific product resource.",
-            parameters: [
-                {
-                    name: "productId",
-                    type: z.string(),
-                    description: "Product UUID, or identifier in the format.",
-                    required: true
-                }
-            ],
-        }, async (args, _extra) => {
-            const productArgs = args;
-            const response = await this.getPortalProduct(productArgs.productId);
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
-        });
-        register({
-            title: "Delete Portal Product",
-            summary: "Delete a product from a specific portal",
-            parameters: [
-                {
-                    name: "productId",
-                    type: z.string(),
-                    description: "Product UUID, or identifier in the format.",
-                    required: true
-                }
-            ],
-        }, async (args, _extra) => {
-            const productArgs = args;
-            await this.deletePortalProduct(productArgs.productId);
-            return {
-                content: [{ type: "text", text: "Product deleted successfully." }],
-            };
-        });
-        register({
-            title: "Update Portal Product",
-            summary: "Update a product's settings within a specific portal.",
-            parameters: [
-                {
-                    name: "productId",
-                    type: z.string(),
-                    description: "Product UUID, or identifier in the format.",
-                    required: true
-                },
-                {
-                    name: "name",
-                    type: z.string(),
-                    description: "Product name.",
-                    required: false
-                },
-                {
-                    name: "slug",
-                    type: z.string(),
-                    description: "URL component for this product. Must be unique within the portal.",
-                    required: false
-                },
-                {
-                    name: "description",
-                    type: z.string(),
-                    description: "Product description.",
-                    required: false
-                },
-                {
-                    name: "public",
-                    type: z.boolean(),
-                    description: "Indicates if the product is public.",
-                    required: false
-                },
-                {
-                    name: "hidden",
-                    type: z.string(),
-                    description: "Indicates if the product is hidden.",
-                    required: false
+                catch (error) {
+                    return {
+                        content: [
+                            {
+                                type: "text",
+                                text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                            },
+                        ],
+                    };
                 }
-            ],
-        }, async (args, _extra) => {
-            const updateProductArgs = args;
-            const response = await this.updatePortalProduct(updateProductArgs.productId, updateProductArgs);
-            return {
-                content: [{ type: "text", text: JSON.stringify(response) }],
-            };
+            });
         });
     }
 }

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

@@ -1,9 +1,13 @@
-import { BaseAPI, pickFieldsFromArray } from './base.js';
+import { BaseAPI, pickFieldsFromArray } from "./base.js";
 // --- API Class ---
 export class CurrentUserAPI extends BaseAPI {
-    static filterFields = ["collaborators_url", "projects_url", "upgrade_url"];
-    static organizationFields = ['id', 'name', 'slug'];
-    static projectFields = ['id', 'name', 'slug', 'api_key'];
+    static filterFields = [
+        "collaborators_url",
+        "projects_url",
+        "upgrade_url",
+    ];
+    static organizationFields = ["id", "name", "slug"];
+    static projectFields = ["id", "name", "slug", "api_key"];
     constructor(configuration) {
         super(configuration, CurrentUserAPI.filterFields);
     }
@@ -15,20 +19,22 @@ export class CurrentUserAPI extends BaseAPI {
         const { admin, paginate = false, ...queryOptions } = options;
         const params = new URLSearchParams();
         if (admin !== undefined)
-            params.append('admin', String(admin));
+            params.append("admin", String(admin));
         for (const [key, value] of Object.entries(queryOptions)) {
             if (value !== undefined)
                 params.append(key, String(value));
         }
-        const url = params.toString() ? `/user/organizations?${params}` : '/user/organizations';
+        const url = params.toString()
+            ? `/user/organizations?${params}`
+            : "/user/organizations";
         const data = await this.request({
-            method: 'GET',
+            method: "GET",
             url,
         }, paginate);
         // Only return allowed fields
         return {
             ...data,
-            body: pickFieldsFromArray(data.body || [], CurrentUserAPI.organizationFields)
+            body: pickFieldsFromArray(data.body || [], CurrentUserAPI.organizationFields),
         };
     }
     /**
@@ -39,7 +45,7 @@ export class CurrentUserAPI extends BaseAPI {
      * @returns A promise that resolves to the list of projects in the organization
      */
     async getOrganizationProjects(organizationId, options = {}) {
-        const { paginate = false, ...queryOptions } = options;
+        const { ...queryOptions } = options;
         const params = new URLSearchParams();
         for (const [key, value] of Object.entries(queryOptions)) {
             if (value !== undefined)
@@ -49,13 +55,12 @@ export class CurrentUserAPI extends BaseAPI {
             ? `/organizations/${organizationId}/projects?${params}`
             : `/organizations/${organizationId}/projects`;
         const data = await this.request({
-            method: 'GET',
+            method: "GET",
             url,
-        }, paginate);
-        // Only return allowed fields
+        }, true); // Always paginate for projects
         return {
             ...data,
-            body: pickFieldsFromArray(data.body || [], CurrentUserAPI.projectFields)
+            body: pickFieldsFromArray(data.body || [], CurrentUserAPI.projectFields),
         };
     }
 }