Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Get Branch Versions

contract-testing_get_branch_versions
Read-onlyIdempotent

Retrieve all published versions from a specific branch of a pacticipant to inspect branch history and version activity.

Instructions

Retrieve all versions published from a specific branch of a pacticipant.

Toolset: Branches and Versions

Parameters:

  • pacticipantName (string) required: Name of the pacticipant

  • branchName (string) required: Name of the branch

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

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

Input Schema

NameRequiredDescriptionDefault
pageSizeNoResults per page
branchNameYesName of the branch
pageNumberNoPage number
pacticipantNameYesName of the pacticipant

Output Schema

NameRequiredDescriptionDefault
pageNo
_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": {
      +    "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"
      +    },
      +    "PacticipantVersionInCollection": {
      +      "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"
      +        },
      +        "_links": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "curies": {
      +              "items": {
      +                "$ref": "#/$defs/EmbeddedLink"
      +              },
      +              "type": "array"
      +            },
      +            "pb:latest-verification-results-where-pacticipant-is-consumer": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:pact-versions": {
      +              "items": {
      +                "$ref": "#/$defs/EmbeddedLink"
      +              },
      +              "type": "array"
      +            },
      +            "pb:pacticipant": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:tag": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "self": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            }
      +          },
      +          "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"
      +    },
      +    "Page": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "number": {
      +          "type": "number"
      +        },
      +        "size": {
      +          "type": "number"
      +        },
      +        "totalElements": {
      +          "type": "number"
      +        },
      +        "totalPages": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "_embedded": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "versions": {
      +          "items": {
      +            "$ref": "#/$defs/PacticipantVersionInCollection"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "_links": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "next": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "pacticipant": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "pb:pacticipant": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "pb:versions": {
      +          "items": {
      +            "$ref": "#/$defs/EmbeddedLink"
      +          },
      +          "type": "array"
      +        },
      +        "previous": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "self": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "versions": {
      +          "description": "Use pb:versions",
      +          "items": {
      +            "$ref": "#/$defs/EmbeddedLink"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "page": {
      +      "$ref": "#/$defs/Page"
      +    }
      +  },
      +  "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=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered elsewhere. The description adds only pagination defaults (page 1, 5 per page), which are also in the schema, and says nothing about ordering or total-count behavior beyond what the output schema presumably carries.

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, but the 'Toolset' line and the full parameter enumeration duplicate structured data the agent already receives. Roughly half the text is redundant with the schema.

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?

With an output schema present and annotations covering the safety profile, the definition supplies enough to call the tool correctly: resource, required inputs and paging defaults. The only real omission is guidance on how this differs from adjacent version-listing tools.

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 every parameter is already documented in the input schema, so the description's parameter block largely restates it. The one small addition is marking pacticipantName and branchName as required, which the schema also declares, 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 uses a specific verb and resource ('Retrieve all versions published from a specific branch of a pacticipant'), which is clearly distinct from siblings like list_pacticipant_versions or get_branch. It stops short of naming those siblings explicitly, so an agent must infer the boundary itself.

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 prerequisites, and no mention of when to prefer contract-testing_list_pacticipant_versions or contract-testing_get_branch instead. The scope ('versions published from a branch') implies usage but never states it.

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