Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Get BDCT Cross-Contract Verification Results

contract-testing_get_bdct_cross-contract_verification_results
Read-onlyIdempotent

Fetch cross-contract verification results for a given provider version to check compatibility and identify issues in Bi-Directional Contract Testing.

Instructions

Fetch the cross-contract verification results for a given provider version in Bi-Directional Contract Testing.

Toolset: Bi-Directional Contract Testing

Parameters:

  • providerName (string) required: Name of the provider

  • providerVersionNumber (string) required: Provider version number

  • pageNumber (number): Page number (default: 1)

  • pageSize (number): Results per page (default: 5)

Input Schema

NameRequiredDescriptionDefault
pageSizeNoResults per page
pageNumberNoPage number
providerNameYesName of the provider
providerVersionNumberYesProvider version number

Output Schema

NameRequiredDescriptionDefault
_linksNo
_actionsNo
_embeddedNo
paginationNo
verificationStatusNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • 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"
      +    },
      +    "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": {
      +        "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"
      +}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds only that results are scoped to a provider version in the BDCT feature; it says nothing about pagination behavior beyond schema defaults, result cardinality, or what happens when no cross-contract verification has run.

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 appropriately short. The trailing "Parameters" block is pure duplication of the input schema and adds no information, so roughly half the text does not earn its place.

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?

An output schema exists and annotations cover the safety profile, so the description doesn't need to explain return values. What is missing is disambiguation from the crowded family of BDCT result tools and any precondition or error context, which matters given how many similar siblings exist.

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% and the description simply restates the same four parameters with the same wording, including the same defaults. It adds no format hints (e.g. whether providerVersionNumber accepts semver or branch-style versions), so the baseline 3 applies.

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 gives a specific verb and resource ("Fetch the cross-contract verification results") scoped to a provider version, which is clearer than a bare restatement of the name. However, it never distinguishes itself from the many near-identical siblings such as get_bdct_provider_contract_verification_results, get_bdct_consumer_contract_verification_results, or get_bdct_x-contract_test_results_by_consumer, so an agent must infer the boundary from tool names alone.

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 guidance, no statement of when to pick this over the sibling verification-result tools, and no prerequisites (e.g. that Bi-Directional Contract Testing must be enabled or that the provider version must already exist). The only contextual hint is the "Bi-Directional Contract Testing" toolset label.

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