Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Get Pacticipant

contract-testing_get_pacticipant
Read-onlyIdempotent

Retrieve details for a specific pacticipant by name, enabling you to identify and inspect an application or service in contract testing.

Instructions

Retrieve details for a specific pacticipant by name.

Toolset: Pacticipants

Parameters:

  • pacticipantName (string) required: Name of the pacticipant (application or service)

Input Schema

NameRequiredDescriptionDefault
pacticipantNameYesName of the pacticipant (application or service)

Output Schema

NameRequiredDescriptionDefault
nameNo
titleNo
_linksNo
_embeddedNo
createdAtNo
updatedAtNo
mainBranchNo
displayNameNo
repositoryUrlNo
repositoryNameNo
repositoryNamespaceNo

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"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "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"
      +}
  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?

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered without the description. The description adds nothing behavioral beyond that: it does not say what happens for an unknown name (error vs. empty) or what 'details' includes. With annotations carrying the load, this is adequate but thin.

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 sentence is front-loaded and efficient, but the 'Toolset' and 'Parameters' sections duplicate information already present in the schema and annotations. Roughly half the text is restatement rather than added value, which dilutes rather than misleads.

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, so return values need not be explained, and the single-parameter signature is fully documented. What is missing is failure behavior for a nonexistent pacticipant name and any hint about what detail fields the response contains. For a simple read tool this is minimally sufficient.

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 bullet repeats the schema text verbatim ('Name of the pacticipant (application or service)'). It adds no meaning beyond the structured field, so the baseline of 3 applies. For a single required identifier there is little more that could usefully be said.

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 states a specific verb and resource: 'Retrieve details for a specific pacticipant by name.' That is enough to separate it from list_pacticipants and create_pacticipant without opening a schema. It stops short of naming those siblings explicitly, so it lands just below the top mark.

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 and no mention of alternatives, even though list_pacticipants and get_pacticipant_version are obvious siblings. The only signal is the word 'specific ... by name', which implies lookup semantics rather than stating them. An agent must infer the routing decision entirely from the tool name.

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