SmartBear MCP server

Official

by SmartBear

Overview Schema Source Related Servers Discussions Admin

TypeScript

Hybrid

Contract Testing: Can I Deploy

contract-testing_can_i_deploy

Read-onlyIdempotent

Checks if a service version is safe to deploy into a target environment by verifying compatibility across its consumer-provider contract matrix.

Instructions

Performs a comprehensive compatibility check to determine whether a specific version of a service (pacticipant) can be safely deployed into a given environment. It analyzes the complete contract matrix of consumer-provider relationships to confirm that all required integrations are verified and compatible.

Toolset: Can I Deploy

Parameters:

pacticipant (string) required: The name of the pacticipant (application/service) being evaluated for deployment
version (string) required: The version of the pacticipant that you want to check if it's safe to deploy
environment (string) required: The target environment where the pacticipant version will be deployed (e.g., 'production', 'staging', 'test')

Input Schema

Name	Required	Description
`version`	Yes	The version of the pacticipant that you want to check if it's safe to deploy
`environment`	Yes	The target environment where the pacticipant version will be deployed (e.g., 'production', 'staging', 'test')
`pacticipant`	Yes	The name of the pacticipant (application/service) being evaluated for deployment

Output Schema

Name	Required	Description	Default
`matrix`	No
`notices`	No
`summary`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.43.0Nov 3, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$defs": {
+    "EmbeddedBranchVersion": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "latest": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedEnvironment": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "production": {
+          "type": "boolean"
+        },
+        "updatedAt": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedLink": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "templated": {
+          "type": "boolean"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "MatrixPacticipant": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "name": {},
+        "version": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/MatrixPacticipantVersion"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "MatrixPacticipantVersion": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "branch": {
+          "description": "Use branchVersions"
+        },
+        "branchVersions": {
+          "items": {
+            "$ref": "#/$defs/EmbeddedBranchVersion"
+          },
+          "type": "array"
+        },
+        "branches": {
+          "description": "Use branchVersions",
+          "items": {
+            "$ref": "#/$defs/EmbeddedBranchVersion"
+          },
+          "type": "array"
+        },
+        "environments": {
+          "items": {
+            "$ref": "#/$defs/EmbeddedEnvironment"
+          },
+          "type": "array"
+        },
+        "number": {
+          "type": "string"
+        },
+        "tags": {
+          "items": {
+            "additionalProperties": {},
+            "properties": {
+              "_links": {
+                "additionalProperties": {},
+                "properties": {
+                  "self": {
+                    "$ref": "#/$defs/EmbeddedLink"
+                  }
+                },
+                "type": "object"
+              },
+              "latest": {
+                "type": "boolean"
+              },
+              "name": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "Notice": {
+      "additionalProperties": {},
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "type": {
+          "anyOf": [
+            {
+              "const": "info",
+              "type": "string"
+            },
+            {
+              "const": "debug",
+              "type": "string"
+            },
+            {
+              "const": "warning",
+              "type": "string"
+            },
+            {
+              "const": "prompt",
+              "type": "string"
+            },
+            {
+              "const": "success",
+              "type": "string"
+            },
+            {
+              "const": "error",
+              "type": "string"
+            }
+          ]
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "matrix": {
+      "items": {
+        "additionalProperties": {},
+        "properties": {
+          "consumer": {
+            "$ref": "#/$defs/MatrixPacticipant"
+          },
+          "pact": {
+            "additionalProperties": {},
+            "properties": {
+              "_links": {
+                "additionalProperties": {},
+                "properties": {
+                  "pfi:ui": {
+                    "$ref": "#/$defs/EmbeddedLink"
+                  },
+                  "self": {
+                    "$ref": "#/$defs/EmbeddedLink"
+                  }
+                },
+                "type": "object"
+              },
+              "createdAt": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "provider": {
+            "$ref": "#/$defs/MatrixPacticipant"
+          },
+          "verificationResult": {
+            "anyOf": [
+              {
+                "additionalProperties": {},
+                "properties": {
+                  "_links": {
+                    "additionalProperties": {},
+                    "properties": {
+                      "pfi:ui": {
+                        "$ref": "#/$defs/EmbeddedLink"
+                      },
+                      "self": {
+                        "$ref": "#/$defs/EmbeddedLink"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "success": {
+                    "type": "boolean"
+                  },
+                  "verifiedAt": {
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "notices": {
+      "items": {
+        "$ref": "#/$defs/Notice"
+      },
+      "type": "array"
+    },
+    "summary": {
+      "additionalProperties": {},
+      "properties": {
+        "deployable": {
+          "description": "The property that indicates whether or not the pacticipant version is safe to deploy.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "failed": {
+          "type": "number"
+        },
+        "reason": {
+          "type": "string"
+        },
+        "success": {
+          "type": "number"
+        },
+        "unknown": {
+          "type": "number"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

Addedv0.40.0Sep 3, 2026
Removedv0.34.0Aug 7, 2026
First observedv0.27.1Jun 29, 2026

TDQS

A3.6/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description still adds real value by disclosing what the analysis actually covers — the complete contract matrix of consumer-provider relationships and verification/compatibility of all required integrations — which tells the agent this is a holistic gate rather than a single-integration lookup.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The lead sentence is front-loaded and well written, but the definition then duplicates the entire input schema under a 'Parameters:' heading plus a 'Toolset' line, which carries no information an agent can act on. Structure is readable, yet a meaningful share of the text is redundant with structured fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so the description need not describe return values, and all three required parameters are documented in both schema and prose. Safety and idempotency are covered by annotations, leaving only the missing sibling routing as a gap for this low-complexity, single-purpose tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the schema already documents pacticipant, version and environment, and the description's parameter list restates those descriptions verbatim, adding no syntax, format or constraint detail (the environment examples 'production/staging/test' appear in both places). Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: a compatibility check to determine whether a named pacticipant version can be deployed into an environment. The scope (full consumer-provider contract matrix) further sharpens intent, but no sibling such as contract-testing_matrix or contract-testing_get_pacticipant_version is named as the alternative, so the differentiation is left implicit.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The deployment-gate framing implies when to use it (before promoting a version to an environment), but there is no explicit guidance on when not to use it or which sibling to prefer for adjacent questions like 'what is currently deployed' or 'what versions are supported'. Usage is inferable rather than stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server