@smartbear/mcp 0.3.0 → 0.4.0

package/README.md

@@ -18,7 +18,7 @@
 </div>
 <br />
 
-A Model Context Protocol (MCP) server which provides AI assistants with seamless access to SmartBear's suite of testing and monitoring tools, including [Insight Hub](https://www.smartbear.com/insight-hub), [Reflect](https://reflect.run), and [API Hub](https://www.smartbear.com/api-hub).
+A Model Context Protocol (MCP) server which provides AI assistants with seamless access to SmartBear's suite of testing and monitoring tools, including [Insight Hub](https://www.smartbear.com/insight-hub), [Reflect](https://reflect.run), [API Hub](https://www.smartbear.com/api-hub), [PactFlow](https://pactflow.io/) and [Pact Broker](https://docs.pact.io/)
 
 ## What is MCP?
 
@@ -31,6 +31,7 @@ See individual guides for suggested prompts and supported tools and resources:
 - [Insight Hub](https://developer.smartbear.com/smartbear-mcp/docs/insight-hub-integration) - Comprehensive error monitoring and debugging capabilities
 - [Test Hub](https://developer.smartbear.com/smartbear-mcp/docs/test-hub-integration) - Test management and execution capabilities
 - [API Hub](https://developer.smartbear.com/smartbear-mcp/docs/api-hub-integration) - Portal management capabilities
+- [PactFlow](https://developer.smartbear.com/pactflow/default/getting-started) - Contract testing capabilities
 
 
 ## Prerequisites
@@ -68,7 +69,11 @@ Alternatively, you can use `npx` (or globally install) the `@smartbear/mcp` pack
         "INSIGHT_HUB_AUTH_TOKEN": "${input:insight_hub_auth_token}",
         "INSIGHT_HUB_PROJECT_API_KEY": "${input:insight_hub_project_api_key}",
         "REFLECT_API_TOKEN": "${input:reflect_api_token}",
-        "API_HUB_API_KEY": "${input:api_hub_api_key}"
+        "API_HUB_API_KEY": "${input:api_hub_api_key}",
+        "PACT_BROKER_BASE_URL": "${input:pact_broker_base_url}",
+        "PACT_BROKER_TOKEN": "${input:pact_broker_token}",
+        "PACT_BROKER_USERNAME": "${input:pact_broker_username}",
+        "PACT_BROKER_PASSWORD": "${input:pact_broker_password}"
       }
     }
   },
@@ -96,7 +101,31 @@ Alternatively, you can use `npx` (or globally install) the `@smartbear/mcp` pack
          "type": "promptString",
          "description": "API Hub API Key - leave blank to disable API Hub tools",
          "password": true
-      }
+      },
+      {
+         "id": "pact_broker_base_url",
+         "type": "promptString",
+         "description": "PactFlow or Pact Broker base url - leave blank to disable the tools",
+         "password": true
+      },
+      {
+         "id": "pact_broker_token",
+         "type": "promptString",
+         "description": "PactFlow Authentication Token",
+         "password": true
+      },
+      {
+         "id": "pact_broker_username",
+         "type": "promptString",
+         "description": "Pact Broker Username",
+         "password": true
+      },
+      {
+         "id": "pact_broker_password",
+         "type": "promptString",
+         "description": "Pact Broker Password",
+         "password": true
+      },
   ]
 }
 ```
@@ -119,7 +148,11 @@ Add the following configuration to your `claude_desktop_config.json` to launch t
         "INSIGHT_HUB_AUTH_TOKEN": "your_personal_auth_token",
         "INSIGHT_HUB_PROJECT_API_KEY": "your_project_api_key",
         "REFLECT_API_TOKEN": "your_reflect_token",
-        "API_HUB_API_KEY": "your_api_hub_key"
+        "API_HUB_API_KEY": "your_api_hub_key",
+        "PACT_BROKER_BASE_URL": "your_pactflow_or_pactbroker_base_url",
+        "PACT_BROKER_TOKEN": "your_pactflow_token",
+        "PACT_BROKER_USERNAME": "your_pact_broker_username",
+        "PACT_BROKER_PASSWORD": "your_pact_broker_password",
       }
     }
   }
@@ -172,7 +205,11 @@ For developers who want to contribute to the SmartBear MCP server, customize its
             "INSIGHT_HUB_AUTH_TOKEN": "${input:insight_hub_auth_token}",
             "INSIGHT_HUB_PROJECT_API_KEY": "${input:insight_hub_project_api_key}",
             "REFLECT_API_TOKEN": "${input:reflect_api_token}",
-            "API_HUB_API_KEY": "${input:api_hub_api_key}"
+            "API_HUB_API_KEY": "${input:api_hub_api_key}",
+            "PACT_BROKER_BASE_URL": "${input:pact_broker_base_url}",
+            "PACT_BROKER_TOKEN": "${input:pact_broker_token}",
+            "PACT_BROKER_USERNAME": "${input:pact_broker_username}",
+            "PACT_BROKER_PASSWORD": "${input:pact_broker_password}"
           }
         }
       },
@@ -200,7 +237,31 @@ For developers who want to contribute to the SmartBear MCP server, customize its
           "type": "promptString",
           "description": "API Hub API Key - leave blank to disable API Hub tools",
           "password": true
-        }
+        },
+        {
+          "id": "pact_broker_base_url",
+          "type": "promptString",
+          "description": "PactFlow or Pact Broker base url - leave blank to disable PactFlow tools",
+          "password": true
+        },
+        {
+          "id": "pact_broker_token",
+          "type": "promptString",
+          "description": "PactFlow Authentication Token",
+          "password": true
+        },
+        {
+          "id": "pact_broker_username",
+          "type": "promptString",
+          "description": "Pact Broker Username",
+          "password": true
+        },
+        {
+          "id": "pact_broker_password",
+          "type": "promptString",
+          "description": "Pact Broker Password",
+          "password": true
+        },
       ]
     }
     ```
@@ -209,7 +270,7 @@ For developers who want to contribute to the SmartBear MCP server, customize its
 5. **Local testing** using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) web interface:
 
     ```bash
-    INSIGHT_HUB_AUTH_TOKEN="your_token" REFLECT_API_TOKEN="your_reflect_token" API_HUB_API_KEY="your_api_hub_key" npx @modelcontextprotocol/inspector npx @smartbear/mcp@latest
+    INSIGHT_HUB_AUTH_TOKEN="your_token" REFLECT_API_TOKEN="your_reflect_token" API_HUB_API_KEY="your_api_hub_key" PACT_BROKER_BASE_URL="your-pactflow-url" PACT_BROKER_TOKEN="your-pactflow-token" PACT_BROKER_USERNAME="your-pact-broker-username" PACT_BROKER_PASSWORD="your-pact-broker-password" npx @modelcontextprotocol/inspector npx @smartbear/mcp@latest
     ```
 
 ## License

package/dist/api-hub/client.js

@@ -3,6 +3,8 @@ import { MCP_SERVER_NAME, MCP_SERVER_VERSION } from "../common/info.js";
 // Tool definitions for API Hub API client
 export class ApiHubClient {
     headers;
+    name = "API Hub";
+    prefix = "api_hub";
     constructor(token) {
         this.headers = {
             "Authorization": `Bearer ${token}`,
@@ -82,99 +84,343 @@ export class ApiHubClient {
         });
         return response.json();
     }
-    registerTools(server) {
-        server.tool("list_portals", "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.", {}, async (_args, _extra) => {
+    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) }],
             };
         });
-        server.tool("create_portal", "Create a new portal within API Hub.", {
-            name: z.string().optional().describe("The portal name."),
-            subdomain: z.string().describe("The portal subdomain."),
-            offline: z.boolean().optional().describe("If set to true the portal will not be visible to customers."),
-            routing: z.string().optional().describe("Determines the routing strategy ('browser' or 'proxy')."),
-            credentialsEnabled: z.string().optional().describe("Indicates if credentials are enabled for the portal."),
-            swaggerHubOrganizationId: z.string().describe("The corresponding API Hub (formerly SwaggerHub) organization UUID."),
-            openapiRenderer: z.string().optional().describe("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."),
-            pageContentFormat: z.string().optional().describe("The format of the page content.")
+        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.",
+                }
+            ],
         }, async (args, _extra) => {
-            const response = await this.createPortal(args);
+            const createPortalArgs = args;
+            const response = await this.createPortal(createPortalArgs);
             return {
                 content: [{ type: "text", text: JSON.stringify(response) }],
             };
         });
-        server.tool("get_portal", "Retrieve information about a specific portal.", { portalId: z.string().describe("Portal UUID or subdomain.") }, async (args, _extra) => {
-            const response = await this.getPortal(args.portalId);
+        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) }],
             };
         });
-        server.tool("delete_portal", "Delete a portal.", { portalId: z.string().describe("Portal UUID or subdomain.") }, async (args, _extra) => {
-            await this.deletePortal(args.portalId);
+        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." }],
             };
         });
-        server.tool("update_portal", "Update a specific portal's configuration", {
-            portalId: z.string().describe("Portal UUID or subdomain."),
-            name: z.string().optional().describe("The portal name."),
-            subdomain: z.string().optional().describe("The portal subdomain."),
-            customDomain: z.boolean().optional().describe("Indicates if the portal has a custom domain."),
-            gtmKey: z.string().optional().describe("Google Tag Manager key for the portal."),
-            offline: z.boolean().optional().describe("If set to true the portal will not be visible to customers."),
-            routing: z.string().optional().describe("Determines the routing strategy ('browser' or 'proxy')."),
-            credentialsEnabled: z.boolean().optional().describe("Indicates if credentials are enabled for the portal."),
-            openapiRenderer: z.string().optional().describe("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."),
-            pageContentFormat: z.string().optional().describe("The format of the page content.")
+        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 response = await this.updatePortal(args.portalId, args);
+            const updatePortalArgs = args;
+            const response = await this.updatePortal(updatePortalArgs.portalId, updatePortalArgs);
             return {
                 content: [{ type: "text", text: JSON.stringify(response) }],
             };
         });
-        server.tool("list_portal_products", "Get products for a specific portal that match your criteria.", { portalId: z.string().describe("Portal UUID or subdomain.") }, async (args, _extra) => {
-            const response = await this.getPortalProducts(args.portalId);
+        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) }],
             };
         });
-        server.tool("create_portal_product", "Create a new product for a specific portal.", {
-            portalId: z.string().describe("Portal UUID or subdomain."),
-            type: z.string().describe("Product type (Allowed values: 'new', 'copy')."),
-            name: z.string().describe("Product name."),
-            slug: z.string().describe("URL component for this product. Must be unique within the portal."),
-            description: z.string().optional().describe("Product description."),
-            public: z.boolean().optional().describe("Indicates if the product is public."),
-            hidden: z.string().optional().describe("Indicates if the product is hidden."),
-            role: z.boolean().optional().describe("Indicates if the product has a role.")
+        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 response = await this.createPortalProduct(args.portalId, args);
+            const createProductArgs = args;
+            const response = await this.createPortalProduct(createProductArgs.portalId, createProductArgs);
             return {
                 content: [{ type: "text", text: JSON.stringify(response) }],
             };
         });
-        server.tool("get_portal_product", "Retrieve information about a specific product resource.", { productId: z.string().describe("Product UUID, or identifier in the format.") }, async (args, _extra) => {
-            const response = await this.getPortalProduct(args.productId);
+        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) }],
             };
         });
-        server.tool("delete_portal_product", "Delete a product from a specific portal", { productId: z.string().describe("Product UUID, or identifier in the format.") }, async (args, _extra) => {
-            await this.deletePortalProduct(args.productId);
+        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." }],
             };
         });
-        server.tool("update_portal_product", "Update a product's settings within a specific portal.", {
-            productId: z.string().describe("Product UUID, or identifier in the format."),
-            name: z.string().optional().describe("Product name."),
-            slug: z.string().optional().describe("URL component for this product. Must be unique within the portal."),
-            description: z.string().optional().describe("Product description."),
-            public: z.boolean().optional().describe("Indicates if the product is public."),
-            hidden: z.string().optional().describe("Indicates if the product is hidden.")
+        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
+                }
+            ],
         }, async (args, _extra) => {
-            const response = await this.updatePortalProduct(args.productId, args);
+            const updateProductArgs = args;
+            const response = await this.updatePortalProduct(updateProductArgs.productId, updateProductArgs);
             return {
                 content: [{ type: "text", text: JSON.stringify(response) }],
             };