Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Get Pacts for Verification

contract-testing_get_pacts_for_verification
Read-onlyIdempotent

Retrieves the pacts a provider must verify using consumer version selectors and WIP or pending pact settings, so contract verification targets the right consumer versions.

Instructions

Retrieve the pacts that a provider should verify, based on consumer version selectors and WIP/pending pact configuration.

Toolset: Contracts

Parameters:

  • providerName (string) required: Name of the provider to get pacts for

  • consumerVersionSelectors (array): Selectors specifying which consumer versions to include

  • includePendingStatus (boolean): Include the pending status in the results

  • includeWipPactsSince (string): Include WIP pacts published since this date (ISO 8601)

  • providerVersionBranch (string): Branch of the provider version being verified

  • providerVersionTags (array): Tags for the provider version being verified

Input Schema

NameRequiredDescriptionDefault
providerNameYesName of the provider to get pacts for
providerVersionTagsNoTags for the provider version being verified
includePendingStatusNoInclude the pending status in the results
includeWipPactsSinceNoInclude WIP pacts published since this date (ISO 8601)
providerVersionBranchNoBranch of the provider version being verified
consumerVersionSelectorsNoSelectors specifying which consumer versions to include

Output Schema

NameRequiredDescriptionDefault
_linksNo
_embeddedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$defs": {
+    "EmbeddedLink": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "templated": {
+          "type": "boolean"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "VerifiablePact": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "shortDescription": {
+          "type": "string"
+        },
+        "verificationProperties": {
+          "additionalProperties": {},
+          "properties": {
+            "notices": {
+              "items": {
+                "additionalProperties": {},
+                "properties": {
+                  "text": {
+                    "type": "string"
+                  },
+                  "when": {
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "type": "array"
+            },
+            "pending": {
+              "type": "boolean"
+            },
+            "wip": {
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "_embedded": {
+      "additionalProperties": {},
+      "properties": {
+        "pacts": {
+          "items": {
+            "$ref": "#/$defs/VerifiablePact"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered elsewhere. The description adds the selection semantics (pacts are chosen by selectors plus WIP/pending settings), which is useful context, but says nothing about auth requirements or how empty results arise.

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 opening sentence is well front-loaded and earns its place, but the 'Toolset: Contracts' label and the full parameter list duplicate structured data already in the schema and annotations, padding the definition without adding information.

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

Completeness3/5

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

Return values need not be described since an output schema exists, and annotations carry the safety profile. However, for a six-parameter tool with a complex nested selector array, the description omits selection rules and defaults, leaving the agent to infer how results are assembled.

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?

Schema description coverage is 100%, so the baseline is 3. The description's parameter list repeats the schema descriptions verbatim and adds no meaning — notably it does not explain selector precedence, defaults when selectors are omitted, or how includeWipPactsSince interacts with includePendingStatus.

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?

The description names a specific verb and resource ('Retrieve the pacts that a provider should verify') and adds the scoping logic (consumer version selectors, WIP/pending configuration). It is clearly distinguishable from sibling read tools like get_pacticipant_version or matrix, though it never explicitly names a sibling it replaces.

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?

Usage is only implied: the mention of consumer version selectors and WIP/pending configuration suggests this belongs to the provider verification workflow. There is no explicit when-to-use, no prerequisites (e.g., publishing pacts first), and no statement about when a different tool should be used instead.

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

Deploy Server

Other Tools