Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: List Pacticipants

contract-testing_list_pacticipants
Read-onlyIdempotent

Retrieve and list all pacticipants (applications or services) registered in a Pact Broker or PactFlow workspace, with pagination controls for browsing results.

Instructions

Retrieve all pacticipants (applications/services) registered in the Pact Broker or PactFlow workspace.

Toolset: Pacticipants

Parameters:

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

  • pageSize (number): Number of results per page (default: 5)

Input Schema

NameRequiredDescriptionDefault
pageSizeNoNumber of results per page
pageNumberNoPage number

Output Schema

NameRequiredDescriptionDefault
pageNo
_linksNo
_embeddedNo
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"
      +    }
      +  },
      +  "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 covered. The description adds useful domain context by identifying the Pact Broker/PactFlow workspace as the source. It does not describe ordering, authentication requirements, or pagination behavior beyond restating the parameters.

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 core purpose is front-loaded in the first sentence. However, the 'Toolset: Pacticipants' line and the parameter list duplicate information already present in annotations and the input schema, adding length without value.

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?

This is a simple listing tool with complete schema coverage, rich annotations, and an output schema, so the description need not explain return values. It covers the resource, the source workspace, and pagination parameters. It remains somewhat incomplete because it does not clarify how this listing relates to the filtered or single-pacticipant sibling 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%, so the two pagination parameters are fully documented in the schema already. The description simply repeats pageNumber and pageSize with the same defaults, adding no new semantics such as whether page numbers are one-based or whether pageSize has a maximum. Baseline 3 is appropriate 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?

The description names a specific verb and resource: retrieve all pacticipants registered in a Pact Broker or PactFlow workspace. It also glosses 'pacticipants' as applications/services, which helps an agent understand the domain object. However, it does not distinguish this tool from siblings such as contract-testing_get_pacticipant or contract-testing_list_pacticipants_by_label.

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?

The word 'all' implies listing every pacticipant, but there is no explicit guidance on when to use this tool versus get_pacticipant, list_pacticipants_by_label, or list_pacticipant_versions. No when-not conditions or alternative-routing instructions are provided.

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