@smartbear/mcp 0.12.1 → 0.13.1

package/dist/swagger/client/configuration.js

@@ -1,34 +1,32 @@
-export class SwaggerConfiguration {
-    token;
-    portalBasePath;
-    registryBasePath;
-    uiBasePath;
-    userManagementBasePath;
-    headers;
-    constructor(param) {
-        this.token = param.token;
-        this.portalBasePath =
-            param.portalBasePath || "https://api.portal.swaggerhub.com/v1";
-        this.registryBasePath =
-            param.registryBasePath || "https://api.swaggerhub.com"; // Default for registry API
-        this.uiBasePath = param.uiBasePath || "https://app.swaggerhub.com"; // Default for UI
-        this.userManagementBasePath =
-            param.userManagementBasePath ||
-                "https://api.swaggerhub.com/user-management/v1";
-        // Use Bearer token format consistently across all APIs
-        this.headers = {
-            Authorization: `Bearer ${this.token}`,
-            "Content-Type": "application/json",
-            ...param.headers,
-        };
-    }
-    /**
-     * Get headers with User-Agent included
-     */
-    getHeaders(userAgent) {
-        return {
-            ...this.headers,
-            "User-Agent": userAgent,
-        };
-    }
+class SwaggerConfiguration {
+  token;
+  portalBasePath;
+  registryBasePath;
+  uiBasePath;
+  userManagementBasePath;
+  headers;
+  constructor(param) {
+    this.token = param.token;
+    this.portalBasePath = param.portalBasePath || "https://api.portal.swaggerhub.com/v1";
+    this.registryBasePath = param.registryBasePath || "https://api.swaggerhub.com";
+    this.uiBasePath = param.uiBasePath || "https://app.swaggerhub.com";
+    this.userManagementBasePath = param.userManagementBasePath || `${this.uiBasePath}/user-management/v1`;
+    this.headers = {
+      Authorization: `Bearer ${this.token}`,
+      "Content-Type": "application/json",
+      ...param.headers
+    };
+  }
+  /**
+   * Get headers with User-Agent included
+   */
+  getHeaders(userAgent) {
+    return {
+      ...this.headers,
+      "User-Agent": userAgent
+    };
+  }
 }
+export {
+  SwaggerConfiguration
+};

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

@@ -1,258 +1,218 @@
 import { z } from "zod";
-// Zod schemas for Portal API validation
-export const PortalArgsSchema = z.object({
-    portalId: z
-        .string()
-        .describe("Portal UUID or subdomain - unique identifier for the portal instance"),
+const PortalArgsSchema = z.object({
+  portalId: z.string().describe(
+    "Portal UUID or subdomain - unique identifier for the portal instance"
+  )
 });
-export const ProductArgsSchema = z.object({
-    productId: z
-        .string()
-        .describe("Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product"),
+const ProductArgsSchema = z.object({
+  productId: z.string().describe(
+    "Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product"
+  )
 });
-export const GetProductSectionsArgsSchema = z.object({
-    productId: z
-        .string()
-        .describe("Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product"),
-    embed: z
-        .array(z.string())
-        .optional()
-        .describe("List of related entities to embed in the response - e.g., ['tableOfContents', 'tableOfContents.swaggerhubApi'] to include table of contents and SwaggerHub API details"),
-    page: z
-        .number()
-        .optional()
-        .describe("Page number for paginated results - specifies which page of results to retrieve (default is 1)"),
-    size: z
-        .number()
-        .optional()
-        .describe("Number of items per page for pagination - controls how many results are returned per page (default is 20)"),
+const GetProductSectionsArgsSchema = z.object({
+  productId: z.string().describe(
+    "Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product"
+  ),
+  embed: z.array(z.string()).optional().describe(
+    "List of related entities to embed in the response - e.g., ['tableOfContents', 'tableOfContents.swaggerhubApi'] to include table of contents and SwaggerHub API details"
+  ),
+  page: z.number().optional().describe(
+    "Page number for paginated results - specifies which page of results to retrieve (default is 1)"
+  ),
+  size: z.number().optional().describe(
+    "Number of items per page for pagination - controls how many results are returned per page (default is 20)"
+  )
 });
-export const GetTableOfContentsArgsSchema = z.object({
-    sectionId: z
-        .string()
-        .describe("Section ID - unique identifier for the section within the product"),
-    embed: z
-        .array(z.string())
-        .optional()
-        .describe("List of related entities to embed in the response - e.g., ['swaggerhubApi'] to include SwaggerHub API details"),
-    page: z
-        .number()
-        .optional()
-        .describe("Page number for paginated results - specifies which page of results to retrieve (default is 1)"),
-    size: z
-        .number()
-        .optional()
-        .describe("Number of items per page for pagination - controls how many results are returned per page (default is 20)"),
+const GetTableOfContentsArgsSchema = z.object({
+  sectionId: z.string().describe(
+    "Section ID - unique identifier for the section within the product"
+  ),
+  embed: z.array(z.string()).optional().describe(
+    "List of related entities to embed in the response - e.g., ['swaggerhubApi'] to include SwaggerHub API details"
+  ),
+  page: z.number().optional().describe(
+    "Page number for paginated results - specifies which page of results to retrieve (default is 1)"
+  ),
+  size: z.number().optional().describe(
+    "Number of items per page for pagination - controls how many results are returned per page (default is 20)"
+  )
 });
-export const CreateTableOfContentsArgsSchema = z.object({
-    sectionId: z
-        .string()
-        .describe("Section ID - unique identifier for the section within the product"),
-    type: z
-        .enum(["new", "copy"])
-        .describe("Type of table of contents creation - 'new' to create from scratch or 'copy' to duplicate an existing one"),
-    title: z
-        .string()
-        .describe("Title of the table of contents item - will be displayed in navigation (3-40 characters)"),
-    slug: z
-        .string()
-        .describe("URL-friendly identifier for the table of contents item - must be unique within the section (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)"),
-    order: z
-        .number()
-        .describe("Order position of the table of contents item within its parent section or item"),
-    parentId: z
-        .string()
-        .nullable()
-        .optional()
-        .describe("Parent table of contents item ID - null for top-level items, or ID of parent item for nested structure"),
-    content: z
-        .object({
-        type: z
-            .enum(["apiUrl", "html", "markdown"])
-            .describe("Content type - 'apiUrl' for API references, 'html' for HTML content, or 'markdown' for Markdown content"),
-        url: z
-            .string()
-            .optional()
-            .describe("URL for API reference content (required when type is 'apiUrl')"),
-        apiSpec: z
-            .string()
-            .nullable()
-            .optional()
-            .describe("API specification format for API URL content"),
-        documentId: z
-            .string()
-            .nullable()
-            .optional()
-            .describe("Document ID for HTML or Markdown content"),
-    })
-        .optional()
-        .describe("Content configuration for the table of contents item")
-        .refine((content) => {
-        if (content?.type === "apiUrl") {
-            return (content.url?.endsWith("/swagger.json") ||
-                content.url?.endsWith("/swagger.yaml"));
-        }
-        return true;
-    }, {
-        message: "URL must end with '/swagger.json' when content type is 'apiUrl'",
-        path: ["url"],
-    }),
+const CreateTableOfContentsArgsSchema = z.object({
+  sectionId: z.string().describe(
+    "Section ID - unique identifier for the section within the product"
+  ),
+  type: z.enum(["new", "copy"]).describe(
+    "Type of table of contents creation - 'new' to create from scratch or 'copy' to duplicate an existing one"
+  ),
+  title: z.string().describe(
+    "Title of the table of contents item - will be displayed in navigation (3-40 characters)"
+  ),
+  slug: z.string().describe(
+    "URL-friendly identifier for the table of contents item - must be unique within the section (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)"
+  ),
+  order: z.number().describe(
+    "Order position of the table of contents item within its parent section or item"
+  ),
+  parentId: z.string().nullable().optional().describe(
+    "Parent table of contents item ID - null for top-level items, or ID of parent item for nested structure"
+  ),
+  content: z.object({
+    type: z.enum(["apiUrl", "html", "markdown"]).describe(
+      "Content type - 'apiUrl' for API references, 'html' for HTML content, or 'markdown' for Markdown content"
+    ),
+    url: z.string().optional().describe(
+      "URL for API reference content (required when type is 'apiUrl')"
+    ),
+    apiSpec: z.string().nullable().optional().describe("API specification format for API URL content"),
+    documentId: z.string().nullable().optional().describe("Document ID for HTML or Markdown content")
+  }).optional().describe("Content configuration for the table of contents item").refine(
+    (content) => {
+      if (content?.type === "apiUrl") {
+        return content.url?.endsWith("/swagger.json") || content.url?.endsWith("/swagger.yaml");
+      }
+      return true;
+    },
+    {
+      message: "URL must end with '/swagger.json' or '/swagger.yaml' when content type is 'apiUrl'",
+      path: ["url"]
+    }
+  )
 });
-export const CreatePortalArgsSchema = z.object({
-    name: z
-        .string()
-        .optional()
-        .describe("The display name for the portal - shown to users and in branding (3-40 characters)"),
-    subdomain: z
-        .string()
-        .describe("The portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens"),
-    offline: z
-        .boolean()
-        .optional()
-        .describe("If true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false"),
-    routing: z
-        .string()
-        .optional()
-        .describe("Routing strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser'"),
-    credentialsEnabled: z
-        .boolean()
-        .optional()
-        .describe("Whether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true"),
-    swaggerHubOrganizationId: z
-        .string()
-        .describe("The corresponding SwaggerHub organization UUID - required for portal creation. This links the portal to your SwaggerHub organization"),
-    openapiRenderer: z
-        .string()
-        .optional()
-        .describe("OpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE'"),
-    pageContentFormat: z
-        .string()
-        .optional()
-        .describe("Format for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML'"),
+const CreatePortalArgsSchema = z.object({
+  name: z.string().optional().describe(
+    "The display name for the portal - shown to users and in branding (3-40 characters)"
+  ),
+  subdomain: z.string().describe(
+    "The portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens"
+  ),
+  offline: z.boolean().optional().describe(
+    "If true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false"
+  ),
+  routing: z.string().optional().describe(
+    "Routing strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser'"
+  ),
+  credentialsEnabled: z.boolean().optional().describe(
+    "Whether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true"
+  ),
+  swaggerHubOrganizationId: z.string().describe(
+    "The corresponding SwaggerHub organization UUID - required for portal creation. This links the portal to your SwaggerHub organization"
+  ),
+  openapiRenderer: z.string().optional().describe(
+    "OpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE'"
+  ),
+  pageContentFormat: z.string().optional().describe(
+    "Format for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML'"
+  )
 });
-export const UpdatePortalArgsSchema = PortalArgsSchema.extend({
-    name: z
-        .string()
-        .optional()
-        .describe("Update the portal display name - shown to users and in branding (3-40 characters)"),
-    subdomain: z
-        .string()
-        .optional()
-        .describe("Update the portal subdomain - changes the portal URL. Must remain unique across all portals (3-20 characters, lowercase, alphanumeric with hyphens)"),
-    customDomain: z
-        .boolean()
-        .optional()
-        .describe("Enable/disable custom domain for the portal - allows using your own domain instead of the default subdomain"),
-    gtmKey: z
-        .string()
-        .optional()
-        .describe("Google Tag Manager key for analytics tracking - format: GTM-XXXXXX (max 25 characters)"),
-    offline: z
-        .boolean()
-        .optional()
-        .describe("Set portal visibility - true hides portal from customers (useful for maintenance or development)"),
-    routing: z
-        .string()
-        .optional()
-        .describe("Update routing strategy - 'browser' for client-side routing or 'proxy' for server-side routing"),
-    credentialsEnabled: z
-        .boolean()
-        .optional()
-        .describe("Enable/disable authentication credentials for portal access - controls whether users can authenticate to view private content"),
-    openapiRenderer: z
-        .string()
-        .optional()
-        .describe("Change OpenAPI renderer: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (switch between both)"),
-    pageContentFormat: z
-        .string()
-        .optional()
-        .describe("Update page content format for documentation rendering: 'HTML', 'MARKDOWN', or 'BOTH'"),
+const UpdatePortalArgsSchema = PortalArgsSchema.extend({
+  name: z.string().optional().describe(
+    "Update the portal display name - shown to users and in branding (3-40 characters)"
+  ),
+  subdomain: z.string().optional().describe(
+    "Update the portal subdomain - changes the portal URL. Must remain unique across all portals (3-20 characters, lowercase, alphanumeric with hyphens)"
+  ),
+  customDomain: z.boolean().optional().describe(
+    "Enable/disable custom domain for the portal - allows using your own domain instead of the default subdomain"
+  ),
+  gtmKey: z.string().optional().describe(
+    "Google Tag Manager key for analytics tracking - format: GTM-XXXXXX (max 25 characters)"
+  ),
+  offline: z.boolean().optional().describe(
+    "Set portal visibility - true hides portal from customers (useful for maintenance or development)"
+  ),
+  routing: z.string().optional().describe(
+    "Update routing strategy - 'browser' for client-side routing or 'proxy' for server-side routing"
+  ),
+  credentialsEnabled: z.boolean().optional().describe(
+    "Enable/disable authentication credentials for portal access - controls whether users can authenticate to view private content"
+  ),
+  openapiRenderer: z.string().optional().describe(
+    "Change OpenAPI renderer: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (switch between both)"
+  ),
+  pageContentFormat: z.string().optional().describe(
+    "Update page content format for documentation rendering: 'HTML', 'MARKDOWN', or 'BOTH'"
+  )
 });
-export const CreateProductArgsSchema = PortalArgsSchema.extend({
-    type: z
-        .string()
-        .describe("Product creation type - 'new' to create from scratch or 'copy' to duplicate an existing product"),
-    productId: z
-        .string()
-        .uuid()
-        .optional()
-        .describe("Source product UUID to copy from - required when type is 'copy', specifies which existing product to duplicate. Omit when type is 'new'"),
-    name: z
-        .string()
-        .describe("Product display name - will be shown to users in the portal navigation and product listings (3-40 characters)"),
-    slug: z
-        .string()
-        .describe("URL-friendly identifier for the product - must be unique within the portal, used in URLs (e.g., 'my-api' becomes /my-api). 3-22 characters, lowercase, alphanumeric with hyphens, underscores, or dots"),
-    description: z
-        .string()
-        .optional()
-        .describe("Product description - explains what the API/product does, shown in product listings and cards (max 110 characters)"),
-    public: z
-        .boolean()
-        .optional()
-        .describe("Whether the product is publicly visible to all portal visitors - false means only authenticated users with appropriate roles can access it"),
-    hidden: z
-        .boolean()
-        .optional()
-        .describe("Whether the product is hidden from the portal landing page navigation menus - useful for internal or draft products"),
-    role: z
-        .boolean()
-        .optional()
-        .describe("Whether the product has role-based access restrictions - controls if specific user roles are required to access the product"),
+const CreateProductArgsSchema = PortalArgsSchema.extend({
+  type: z.string().describe(
+    "Product creation type - 'new' to create from scratch or 'copy' to duplicate an existing product"
+  ),
+  productId: z.string().uuid().optional().describe(
+    "Source product UUID to copy from - required when type is 'copy', specifies which existing product to duplicate. Omit when type is 'new'"
+  ),
+  name: z.string().describe(
+    "Product display name - will be shown to users in the portal navigation and product listings (3-40 characters)"
+  ),
+  slug: z.string().describe(
+    "URL-friendly identifier for the product - must be unique within the portal, used in URLs (e.g., 'my-api' becomes /my-api). 3-22 characters, lowercase, alphanumeric with hyphens, underscores, or dots"
+  ),
+  description: z.string().optional().describe(
+    "Product description - explains what the API/product does, shown in product listings and cards (max 110 characters)"
+  ),
+  public: z.boolean().optional().describe(
+    "Whether the product is publicly visible to all portal visitors - false means only authenticated users with appropriate roles can access it"
+  ),
+  hidden: z.boolean().optional().describe(
+    "Whether the product is hidden from the portal landing page navigation menus - useful for internal or draft products"
+  ),
+  role: z.boolean().optional().describe(
+    "Whether the product has role-based access restrictions - controls if specific user roles are required to access the product"
+  )
 });
-export const UpdateProductArgsSchema = ProductArgsSchema.extend({
-    name: z
-        .string()
-        .optional()
-        .describe("Update product display name - changes how it appears to users in navigation and listings (3-40 characters)"),
-    slug: z
-        .string()
-        .optional()
-        .describe("Update URL-friendly identifier - must remain unique within the portal, affects product URLs (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)"),
-    description: z
-        .string()
-        .optional()
-        .describe("Update product description - explains the API/product functionality, shown in listings (max 110 characters)"),
-    public: z
-        .boolean()
-        .optional()
-        .describe("Change product visibility - true makes it publicly accessible to all visitors, false restricts to authenticated users with roles"),
-    hidden: z
-        .boolean()
-        .optional()
-        .describe("Change navigation visibility - true hides from portal landing page menus while keeping the product accessible via direct links"),
+const UpdateProductArgsSchema = ProductArgsSchema.extend({
+  name: z.string().optional().describe(
+    "Update product display name - changes how it appears to users in navigation and listings (3-40 characters)"
+  ),
+  slug: z.string().optional().describe(
+    "Update URL-friendly identifier - must remain unique within the portal, affects product URLs (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)"
+  ),
+  description: z.string().optional().describe(
+    "Update product description - explains the API/product functionality, shown in listings (max 110 characters)"
+  ),
+  public: z.boolean().optional().describe(
+    "Change product visibility - true makes it publicly accessible to all visitors, false restricts to authenticated users with roles"
+  ),
+  hidden: z.boolean().optional().describe(
+    "Change navigation visibility - true hides from portal landing page menus while keeping the product accessible via direct links"
+  )
 });
-export const PublishProductArgsSchema = ProductArgsSchema.extend({
-    preview: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe("Whether to publish as preview (true) or live (false). Preview allows testing before going live. Defaults to false (live publication)"),
+const PublishProductArgsSchema = ProductArgsSchema.extend({
+  preview: z.boolean().optional().default(false).describe(
+    "Whether to publish as preview (true) or live (false). Preview allows testing before going live. Defaults to false (live publication)"
+  )
 });
-// Document management schemas
-export const GetDocumentArgsSchema = z.object({
-    documentId: z
-        .string()
-        .describe("Document UUID - unique identifier for the document"),
+const GetDocumentArgsSchema = z.object({
+  documentId: z.string().describe("Document UUID - unique identifier for the document")
 });
-export const UpdateDocumentArgsSchema = z.object({
-    documentId: z
-        .string()
-        .describe("Document UUID - unique identifier for the document"),
-    content: z
-        .string()
-        .describe("The document content to update (HTML or Markdown based on document type)"),
-    type: z
-        .enum(["html", "markdown"])
-        .optional()
-        .describe("Content type - 'html' for HTML content or 'markdown' for Markdown content"),
+const UpdateDocumentArgsSchema = z.object({
+  documentId: z.string().describe("Document UUID - unique identifier for the document"),
+  content: z.string().describe(
+    "The document content to update (HTML or Markdown based on document type)"
+  ),
+  type: z.enum(["html", "markdown"]).optional().describe(
+    "Content type - 'html' for HTML content or 'markdown' for Markdown content"
+  )
 });
-export const DeleteTableOfContentsArgsSchema = z.object({
-    tableOfContentsId: z
-        .string()
-        .describe("The table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug'"),
-    recursive: z
-        .boolean()
-        .optional()
-        .describe("Flag to include all the nested tables of contents (default: false)"),
+const DeleteTableOfContentsArgsSchema = z.object({
+  tableOfContentsId: z.string().describe(
+    "The table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug'"
+  ),
+  recursive: z.boolean().optional().describe(
+    "Flag to include all the nested tables of contents (default: false)"
+  )
 });
+export {
+  CreatePortalArgsSchema,
+  CreateProductArgsSchema,
+  CreateTableOfContentsArgsSchema,
+  DeleteTableOfContentsArgsSchema,
+  GetDocumentArgsSchema,
+  GetProductSectionsArgsSchema,
+  GetTableOfContentsArgsSchema,
+  PortalArgsSchema,
+  ProductArgsSchema,
+  PublishProductArgsSchema,
+  UpdateDocumentArgsSchema,
+  UpdatePortalArgsSchema,
+  UpdateProductArgsSchema
+};