SmartBear MCP server

Official

by SmartBear

Overview Schema Source Related Servers Discussions Admin

TypeScript

Hybrid

Contract Testing: Update Pacticipant

contract-testing_update_pacticipant

Idempotent

Replace a pacticipant's metadata, including display name, main branch, and repository details, to keep contract-testing participant records accurate and current.

Instructions

Fully replace a pacticipant's metadata (display name, main branch, repository URL, etc.).

Toolset: Pacticipants

Parameters:

pacticipantName (string) required: Name of the pacticipant to update
displayName (string): Human-readable display name
mainBranch (string): Name of the main/trunk branch (e.g. 'main')
repositoryName (string): Repository name
repositoryNamespace (string): Repository namespace/organisation
repositoryUrl (string): URL of the source repository

Input Schema

Name	Required	Description
`mainBranch`	No	Name of the main/trunk branch (e.g. 'main')
`displayName`	No	Human-readable display name
`repositoryUrl`	No	URL of the source repository
`repositoryName`	No	Repository name
`pacticipantName`	Yes	Name of the pacticipant to update
`repositoryNamespace`	No	Repository namespace/organisation

Output Schema

Name	Required	Description	Default
`name`	No
`title`	No
`_links`	No
`_embedded`	No
`createdAt`	No
`updatedAt`	No
`mainBranch`	No
`displayName`	No
`repositoryUrl`	No
`repositoryName`	No
`repositoryNamespace`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.43.0Nov 3, 2026

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"
+}

Addedv0.40.0Sep 3, 2026
Removedv0.34.0Aug 7, 2026
First observedv0.27.1Jun 29, 2026

TDQS

B3.1/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false, idempotentHint=true, openWorldHint=false, and destructiveHint=false. The description's contribution is the word 'Fully replace', which usefully warns that omitted metadata may be overwritten — behavior the annotations do not convey. It stops short of stating what happens to fields not supplied, permission requirements, or whether the change is reversible.

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 purpose sentence is front-loaded and tight, but the bulk of the body is a parameter list that duplicates a schema already at 100% coverage, plus a '**Toolset:**' line that adds little. Roughly half the text does not earn its place.

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 and annotations cover the safety profile, so the description need not explain return values. However, for a mutating tool that replaces a whole resource, it omits what happens to fields omitted from the call and any prerequisites such as team/permission scope, leaving a meaningful gap.

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 every parameter is already documented in the input schema; the description simply repeats the same one-line descriptions verbatim (e.g. 'Name of the main/trunk branch (e.g. 'main')'). No formats, constraints, or interactions between fields are added, 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 states a specific verb and resource: 'Fully replace a pacticipant's metadata', and enumerates the fields covered (display name, main branch, repository URL). 'Fully replace' signals PUT-style semantics, which implicitly distinguishes it from the sibling contract-testing_patch_pacticipant, but that sibling is never named.

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 explicit when-to-use or when-not-to-use guidance, and no alternative is named even though contract-testing_patch_pacticipant and contract-testing_create_pacticipant sit right next to it. The only hint is the phrase 'fully replace', leaving the agent to infer that partial edits belong elsewhere.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server