SmartBear MCP server

Official

by SmartBear

Overview Schema Source Related Servers Discussions Admin

TypeScript

Hybrid

Contract Testing: Get BDCT Provider by Consumer Version

contract-testing_get_bdct_provider_by_consumer_version

Read-onlyIdempotent

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

Instructions

Fetch the provider OpenAPI 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"
+    },
+    "Contact": {
+      "additionalProperties": {},
+      "properties": {
+        "details": {
+          "additionalProperties": {},
+          "properties": {},
+          "type": "object"
+        },
+        "name": {
+          "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"
+    },
+    "ProviderContract": {
+      "additionalProperties": {},
+      "properties": {
+        "content": {
+          "type": "string"
+        },
+        "contentType": {
+          "type": "string"
+        },
+        "contractType": {
+          "type": "string"
+        },
+        "createdAt": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "ProviderContractVerificationResultsInProviderContract": {
+      "additionalProperties": {},
+      "properties": {
+        "content": {
+          "type": "string"
+        },
+        "contentType": {
+          "type": "string"
+        },
+        "success": {
+          "type": "boolean"
+        },
+        "verifier": {
+          "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": {
+        "consumerContractVerificationResults": {
+          "$ref": "#/$defs/VerificationSuccess"
+        },
+        "consumerVersion": {
+          "$ref": "#/$defs/PacticipantVersionWithoutLinks"
+        },
+        "crossContractVerificationResults": {
+          "$ref": "#/$defs/VerificationSuccess"
+        },
+        "providerContract": {
+          "$ref": "#/$defs/ProviderContract"
+        },
+        "providerContractVerificationResults": {
+          "$ref": "#/$defs/ProviderContractVerificationResultsInProviderContract"
+        },
+        "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.1/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 that the payload is an OpenAPI contract in the BDCT feature area, but says nothing about behaviour when no BDCT contract exists, entitlement requirements, or the pagination envelope beyond repeating the schema defaults.

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 does the real work, but the toolset header and the full bulleted parameter list duplicate structured data already supplied, roughly doubling the length 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?

For a simple read tool with a 100%-covered schema and an output schema (so return values need no explanation), the definition is adequate. Its gap is disambiguation from the closely related BDCT getters, which an agent needs in order to select this tool confidently.

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 schema already documents all six parameters with their defaults. The 'Parameters:' block in the description is a verbatim restatement and adds no meaning such as version-number format, name casing, or whether pageSize applies to contract content.

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 first sentence names a specific verb and resource ('Fetch the provider OpenAPI contract') and scopes it to a 'specific consumer-provider version pair in Bi-Directional Contract Testing', which implicitly separates it from the sibling get_bdct_provider_contract (provider-version only). It stops short of naming that sibling, so the differentiation must be inferred from the parameter list rather than stated.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance. With near-identical siblings such as contract-testing_get_bdct_provider_contract and contract-testing_get_bdct_consumer_by_consumer_version in the toolset, the agent must guess which to call; only the required-parameter list hints at the selection rule.

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

Deploy Server