SmartBear MCP server

Official

by SmartBear

Overview Schema Source Related Servers Discussions Admin

TypeScript

Hybrid

Contract Testing: Get BDCT Consumer by Consumer Version

contract-testing_get_bdct_consumer_by_consumer_version

Read-onlyIdempotent

Fetch the consumer Pact contract for a specific consumer and provider version pair to verify Bi-Directional Contract Testing compatibility.

Instructions

Fetch the consumer Pact contract for a specific consumer-provider version pair in Bi-Directional Contract Testing.

Toolset: Bi-Directional Contract Testing

Parameters:

providerName (string) required: Name of the provider
providerVersionNumber (string) required: Provider version number
consumerName (string) required: Name of the consumer
consumerVersionNumber (string) required: Consumer version number
pageNumber (number): Page number (default: 1)
pageSize (number): Results per page (default: 5)

Input Schema

Name	Required	Description
`pageSize`	No	Results per page
`pageNumber`	No	Page number
`consumerName`	Yes	Name of the consumer
`providerName`	Yes	Name of the provider
`consumerVersionNumber`	Yes	Consumer version number
`providerVersionNumber`	Yes	Provider version number

Output Schema

Name	Required	Description	Default
`_links`	No
`_actions`	No
`_embedded`	No
`pagination`	No
`verificationStatus`	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": {
+    "Action": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "method": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "ConsumerContract": {
+      "additionalProperties": {},
+      "properties": {
+        "content": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "Contact": {
+      "additionalProperties": {},
+      "properties": {
+        "details": {
+          "additionalProperties": {},
+          "properties": {},
+          "type": "object"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "CrossContractVerificationResultsInConsumerContract": {
+      "additionalProperties": {},
+      "properties": {
+        "results": {
+          "additionalProperties": {},
+          "properties": {},
+          "type": "object"
+        },
+        "success": {
+          "type": "boolean"
+        },
+        "verificationDate": {
+          "type": "string"
+        },
+        "verifier": {
+          "type": "string"
+        },
+        "verifierVersion": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedBranchVersion": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "latest": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedDeployedVersion": {
+      "additionalProperties": {},
+      "properties": {
+        "_embedded": {
+          "additionalProperties": {},
+          "properties": {
+            "environment": {
+              "$ref": "#/$defs/Environment"
+            },
+            "pacticipant": {
+              "$ref": "#/$defs/EmbeddedNamed"
+            },
+            "version": {
+              "$ref": "#/$defs/EmbeddedVersion"
+            }
+          },
+          "type": "object"
+        },
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "applicationInstance": {
+          "type": "string"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "currentlyDeployed": {
+          "type": "boolean"
+        },
+        "target": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedLink": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "templated": {
+          "type": "boolean"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedNamed": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedReleasedVersion": {
+      "additionalProperties": {},
+      "properties": {
+        "_embedded": {
+          "additionalProperties": {},
+          "properties": {
+            "environment": {
+              "$ref": "#/$defs/Environment"
+            },
+            "pacticipant": {
+              "$ref": "#/$defs/EmbeddedNamed"
+            },
+            "version": {
+              "$ref": "#/$defs/EmbeddedVersion"
+            }
+          },
+          "type": "object"
+        },
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "currentlySupported": {
+          "type": "boolean"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedTeam": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "isDefault": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedVersion": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "number": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "Environment": {
+      "additionalProperties": {},
+      "properties": {
+        "_embedded": {
+          "additionalProperties": {},
+          "properties": {
+            "teams": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedTeam"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "pb:currently-deployed-deployed-versions": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "pb:currently-supported-released-versions": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "pb:environments": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "contacts": {
+          "items": {
+            "$ref": "#/$defs/Contact"
+          },
+          "type": "array"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "isDefault": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "production": {
+          "type": "boolean"
+        },
+        "teamUuids": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "updatedAt": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "PacticipantVersionWithoutLinks": {
+      "additionalProperties": {},
+      "properties": {
+        "_embedded": {
+          "additionalProperties": {},
+          "properties": {
+            "branchVersions": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedBranchVersion"
+              },
+              "type": "array"
+            },
+            "deployedVersions": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedDeployedVersion"
+              },
+              "type": "array"
+            },
+            "releasedVersions": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedReleasedVersion"
+              },
+              "type": "array"
+            },
+            "tags": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedNamed"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
+        "buildUrl": {
+          "description": "Setting the buildUrl in the version resource is deprecated as it is now set when publishing consumer and provider contracts using the /contracts/publish and /provider-contracts/provider/{provider_name}/publish endpoints.",
+          "type": "string"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "number": {
+          "type": "string"
+        },
+        "updatedAt": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "VerificationSuccess": {
+      "additionalProperties": {},
+      "properties": {
+        "success": {
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "_actions": {
+      "items": {
+        "$ref": "#/$defs/Action"
+      },
+      "type": "array"
+    },
+    "_embedded": {
+      "additionalProperties": {},
+      "properties": {
+        "consumerContract": {
+          "$ref": "#/$defs/ConsumerContract"
+        },
+        "consumerContractVerificationResults": {
+          "$ref": "#/$defs/VerificationSuccess"
+        },
+        "consumerVersion": {
+          "$ref": "#/$defs/PacticipantVersionWithoutLinks"
+        },
+        "crossContractVerificationResults": {
+          "$ref": "#/$defs/CrossContractVerificationResultsInConsumerContract"
+        },
+        "providerContractVerificationResults": {
+          "$ref": "#/$defs/VerificationSuccess"
+        },
+        "providerVersion": {
+          "$ref": "#/$defs/PacticipantVersionWithoutLinks"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {},
+      "type": "object"
+    },
+    "pagination": {
+      "additionalProperties": false,
+      "properties": {
+        "pageNumber": {
+          "type": "number"
+        },
+        "pageSize": {
+          "type": "number"
+        },
+        "totalItems": {
+          "type": "number"
+        },
+        "totalPages": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "pageNumber",
+        "pageSize",
+        "totalItems",
+        "totalPages"
+      ],
+      "type": "object"
+    },
+    "verificationStatus": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

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

TDQS

B3.3/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds only the toolset grouping label and pagination defaults (already in the schema) — nothing about what a 'consumer contract' response contains or how paging behaves past page 1.

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 first sentence is well front-loaded and earns its place, but the trailing 'Parameters' block duplicates the input schema verbatim, adding length without new 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?

With an output schema present and full annotation coverage, the definition does not need to explain return values. However, for a 6-parameter paginated fetch in a crowded BDCT toolset, it says nothing about pagination behaviour or how it relates to the neighbouring BDCT contract tools, leaving a moderate gap.

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 parameter list in the description merely restates the schema's own field descriptions and defaults. It adds no meaning such as accepted version-number formats, branch/tag semantics, or what pageSize bounds are allowed.

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 opening sentence uses a specific verb ('Fetch') and resource ('the consumer Pact contract') scoped to a 'specific consumer-provider version pair in Bi-Directional Contract Testing'. That is enough to distinguish it from provider-side siblings such as get_bdct_provider_contract, though no sibling is named explicitly.

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 by the required version-pair parameters; there is no statement of when to prefer this over get_bdct_consumer_contracts or get_bdct_consumer_by_consumer_version-style listings, and no prerequisites or exclusions are given.

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

Deploy Server