Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: List Pacticipants by Label

contract-testing_list_pacticipants_by_label
Read-onlyIdempotent

Retrieve all pacticipants that have a specific label applied, enabling filtered contract-testing participant lookups by label name.

Instructions

Retrieve all pacticipants that have a specific label applied.

Toolset: Labels

Parameters:

  • labelName (string) required: Label name to filter by

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

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

Input Schema

NameRequiredDescriptionDefault
pageSizeNoResults per page
labelNameYesLabel name to filter by
pageNumberNoPage number

Output Schema

NameRequiredDescriptionDefault
pageNo
_linksNo
_embeddedNo
paginationNo
pacticipantsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "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"
      +    },
      +    "EmbeddedTeam": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "_links": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "self": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "isDefault": {
      +          "type": "boolean"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "uuid": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "Pacticipant": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "_embedded": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "labels": {
      +              "items": {
      +                "$ref": "#/$defs/EmbeddedNamed"
      +              },
      +              "type": "array"
      +            },
      +            "latest-version": {
      +              "additionalProperties": {},
      +              "description": "Use latestVersion",
      +              "properties": {
      +                "name": {
      +                  "type": "string"
      +                },
      +                "number": {
      +                  "type": "string"
      +                },
      +                "title": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "latestVersion": {
      +              "additionalProperties": {},
      +              "properties": {
      +                "_links": {
      +                  "additionalProperties": {},
      +                  "properties": {
      +                    "self": {
      +                      "$ref": "#/$defs/EmbeddedLink"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "number": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "teams": {
      +              "description": "The teams this pacticipant belongs to. Always embedded on the single pacticipant endpoint, and on the collection endpoint when requested via ?include=teams.",
      +              "items": {
      +                "$ref": "#/$defs/EmbeddedTeam"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "_links": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "curies": {
      +              "items": {
      +                "$ref": "#/$defs/EmbeddedLink"
      +              },
      +              "type": "array"
      +            },
      +            "pb:branch-version": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:branches": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:can-i-deploy-badge": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:can-i-deploy-branch-to-environment-badge": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:label": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:teams": {
      +              "description": "Links to the admin team resource for each team this pacticipant belongs to. Present whenever the teams are embedded.",
      +              "items": {
      +                "$ref": "#/$defs/EmbeddedLink"
      +              },
      +              "type": "array"
      +            },
      +            "pb:version": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:version-tag": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "pb:versions": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "self": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            },
      +            "versions": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "createdAt": {
      +          "type": "string"
      +        },
      +        "displayName": {
      +          "type": "string"
      +        },
      +        "mainBranch": {
      +          "type": "string"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "repositoryName": {
      +          "type": "string"
      +        },
      +        "repositoryNamespace": {
      +          "type": "string"
      +        },
      +        "repositoryUrl": {
      +          "type": "string"
      +        },
      +        "title": {
      +          "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": {
      +        "pacticipants": {
      +          "items": {
      +            "$ref": "#/$defs/Pacticipant"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "_links": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "next": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "pacticipants": {
      +          "items": {
      +            "$ref": "#/$defs/EmbeddedLink"
      +          },
      +          "type": "array"
      +        },
      +        "pb:pacticipants": {
      +          "items": {
      +            "$ref": "#/$defs/EmbeddedLink"
      +          },
      +          "type": "array"
      +        },
      +        "pb:pacticipants-with-label": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "previous": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "self": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "pacticipants": {
      +      "items": {
      +        "$ref": "#/$defs/Pacticipant"
      +      },
      +      "type": "array"
      +    },
      +    "page": {
      +      "$ref": "#/$defs/Page"
      +    },
      +    "pagination": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "pageNumber": {
      +          "type": "number"
      +        },
      +        "pageSize": {
      +          "type": "number"
      +        },
      +        "totalItems": {
      +          "type": "number"
      +        },
      +        "totalPages": {
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "pageNumber",
      +        "pageSize",
      +        "totalItems",
      +        "totalPages"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.4/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 the fact that results are paginated with defaults of page 1 and 5 per page; it says nothing about ordering, total counts, or what happens with an unknown label (empty set vs error).

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 front-loaded and wastes nothing, but the bulleted Parameters section merely restates structured schema fields, which earns no credit and pads the definition. The toolset line is minor navigation metadata rather than substantive content.

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 need not be explained, and the annotations cover safety. For a simple three-parameter paginated list tool this is close to sufficient, with only pagination traversal behavior and empty-result handling left unstated.

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's parameter block reproduces the schema wording and defaults verbatim, adding no new meaning such as label case sensitivity, max pageSize, or whether labelName must match exactly. The baseline of 3 applies when the schema already does the work.

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 ('Retrieve all pacticipants') plus the filtering scope ('that have a specific label applied'), which distinguishes it from the plain list_pacticipants sibling. It stops short of explicitly naming the alternative tools it supersedes, so it is clear but not maximally differentiated.

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: the label filter suggests the tool is for label-scoped lookups rather than full enumeration, but the description never says when to use this instead of contract-testing_list_pacticipants or how it relates to contract-testing_get_pacticipant_label. No exclusions or prerequisites are stated.

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