Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Get BDCT Consumer Pact Test Results by Consumer

contract-testing_get_bdct_consumer_pact_test_results_by_consumer
Read-onlyIdempotent

Fetches consumer contract verification results for a specific consumer-provider version pair in Bi-Directional Contract Testing, with pagination.

Instructions

Fetch the consumer contract verification results 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

NameRequiredDescriptionDefault
pageSizeNoResults per page
pageNumberNoPage number
consumerNameYesName of the consumer
providerNameYesName of the provider
consumerVersionNumberYesConsumer version number
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"
      +    },
      +    "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/VerificationSuccess"
      +        },
      +        "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.2/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. The description adds only the pagination defaults (page 1, size 5), which hints at result-set size but says nothing about ordering or what happens when the version pair has no verifications. With annotations carrying the burden, a 3 is appropriate.

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 purpose sentence is tight and front-loaded, but the entire 'Parameters' block duplicates the input schema verbatim and consumes roughly half the description without adding information. Structure is readable but the redundancy costs it.

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 return values needn't be described, and the read-only, paginated nature of the call is clear. For a six-parameter read tool this is largely complete; the missing piece is sibling differentiation, which is scored separately.

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. The description's parameter list restates names, required flags, and defaults verbatim without adding format hints (e.g. whether providerVersionNumber accepts branch/latest aliases). Baseline 3 applies 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 ('Fetch'), resource ('consumer contract verification results'), and scope ('specific consumer-provider version pair in Bi-Directional Contract Testing'). This is distinguishable from provider-side siblings, but the description never names the close alternatives (e.g. get_bdct_consumer_contract_verification_results, get_bdct_x-contract_test_results_by_consumer) so the agent must infer which variant fits.

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?

No statement of when to use this tool versus the many BDCT siblings that also return verification/test results, and no prerequisites such as whether the version pair must already be recorded. The only context is the 'Toolset: Bi-Directional Contract Testing' label, which is implied usage at best.

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